diff --git a/404.html b/404.html index 91cbf0abb..6c9c2ed27 100644 --- a/404.html +++ b/404.html @@ -7,13 +7,13 @@ - - + +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - + + \ No newline at end of file diff --git a/api/classes/headstartwp_core.AbstractFetchStrategy/index.html b/api/classes/headstartwp_core.AbstractFetchStrategy/index.html index db43f59b5..36d10bfc9 100644 --- a/api/classes/headstartwp_core.AbstractFetchStrategy/index.html +++ b/api/classes/headstartwp_core.AbstractFetchStrategy/index.html @@ -7,18 +7,18 @@ - - + +
Skip to main content

Class: AbstractFetchStrategy<E, Params, R>

@headstartwp/core.AbstractFetchStrategy

Abstract class that lays out a strategy for fetching data

All Fetch Strategies should implement this class and it allows to share logic for fetching data both -on the front-end and on the back-end.

Type parameters​

NameTypeDescription
EEThe type of entity that is fetched (e.g PostEntity, TermEntity etc)
Paramsextends EndpointParamsThe type of the params that are passed to the endpoint
RE-

Hierarchy​

Constructors​

constructor​

• new AbstractFetchStrategy<E, Params, R>(baseURL?, defaultParams?)

The strategy constructor

Type parameters​

NameType
EE
Paramsextends EndpointParams
RE

Parameters​

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<Params>(optional) list of default params

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:143

Properties​

baseURL​

• baseURL: string = ''

The base URL where the API is located

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

defaultParams​

• defaultParams: Partial<Params> = {}

The Default Params

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:119

endpoint​

• endpoint: string = ''

Holds the current endpoint for the strategy

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:124

Methods​

buildEndpointURL​

▸ buildEndpointURL(params): string

Builds the final endpoint URL based on the passed parameters

Parameters​

NameTypeDescription
paramsPartial<Params>The params to add to the request

Returns​

string

The endpoint URL.

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:220

fetcher​

▸ fetcher(url, params, options?): Promise<FetchResponse<R>>

The default fetcher function

The default fetcher function handles authentication headers and errors from the API.

A custom strategy can override this function to run additional logic before or after the fetch call

Parameters​

NameTypeDescription
urlstringThe URL to fetch
paramsPartial<Params>The request params
optionsPartial<FetchOptions>The fetcher options

Returns​

Promise<FetchResponse<R>>

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:290

filterData​

▸ filterData(data, filterOptions?): FetchResponse<R>

Filters the data returned from the API by excluding fields that are not needed in order to reduce -payload size.

Parameters​

NameTypeDescription
dataFetchResponse<R>The data to filter
filterOptions?FilterDataOptions<R>Filter options

Returns​

FetchResponse<R>

The filtered data

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:377

get​

▸ get(params?): Promise<FetchResponse<R>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage​

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters​

NameTypeDescription
paramsPartial<Params>The endpoint params

Returns​

Promise<FetchResponse<R>>

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:442

getAuthHeader​

▸ getAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:256

getCacheKey​

▸ getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters​

NameTypeDescription
paramsPartial<Params>The request params

Returns​

Object

The cache key object

NameType
argsPartial<Params> & { sourceUrl: string }
urlstring

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:407

getDefaultEndpoint​

▸ Abstract getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint -for the strategy

Returns​

string

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:135

getDefaultParams​

▸ getDefaultParams(): Partial<Params>

Returns​

Partial<Params>

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:182

getEndpoint​

▸ getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, -returns the default endpoint

Returns​

string

The current endpoint for the strategy

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:174

getParamsFromURL​

▸ Abstract getParamsFromURL(path, nonUrlParams): Partial<Params>

Returns the supported params from the URL if present.

These params are passed to buildEndpointURL. If the strategy does not support -mapping url params to endpoint params, it should return an empty object.

Parameters​

NameTypeDescription
pathstringThe Path name
nonUrlParamsPartial<Params>The non-url params

Returns​

Partial<Params>

params extracted from the URL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:197

getPreviewAuthHeader​

▸ getPreviewAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:247

getPreviewHeaderName​

▸ getPreviewHeaderName(options?): "X-HeadstartWP-Authorization" | "Authorization"

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

"X-HeadstartWP-Authorization" | "Authorization"

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:241

getQueriedObject​

▸ getQueriedObject(response, params): Object

Parameters​

NameType
responseFetchResponse<E>
paramsPartial<Params>

Returns​

Object

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:365

isMainQuery​

▸ isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters​

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<Params>The non-url params

Returns​

boolean

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:205

normalizeForCache​

▸ normalizeForCache(data, params): NormalizedDataForCache<R, Params>

Normalize data for cache.

Parameters​

NameTypeDescription
dataFetchResponse<R>The fetch response data
paramsPartial<Params>The request params

Returns​

NormalizedDataForCache<R, Params>

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:417

prepareResponse​

▸ prepareResponse(response, params): FetchResponse<R>

Parameters​

NameType
responseFetchResponse<E>
paramsPartial<Params>

Returns​

FetchResponse<R>

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:233

setBaseURL​

▸ setBaseURL(url?): void

Parameters​

NameTypeDefault value
urlundefined | string''

Returns​

void

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:164

setEndpoint​

▸ setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters​

NameTypeDescription
endpointstringThe endpoint to fetch

Returns​

void

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +on the front-end and on the back-end.

Type parameters​

NameTypeDescription
EEThe type of entity that is fetched (e.g PostEntity, TermEntity etc)
Paramsextends EndpointParamsThe type of the params that are passed to the endpoint
RE-

Hierarchy​

Constructors​

constructor​

• new AbstractFetchStrategy<E, Params, R>(baseURL?, defaultParams?)

The strategy constructor

Type parameters​

NameType
EE
Paramsextends EndpointParams
RE

Parameters​

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<Params>(optional) list of default params

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:143

Properties​

baseURL​

• baseURL: string = ''

The base URL where the API is located

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

defaultParams​

• defaultParams: Partial<Params> = {}

The Default Params

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:119

endpoint​

• endpoint: string = ''

Holds the current endpoint for the strategy

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:124

Methods​

buildEndpointURL​

▸ buildEndpointURL(params): string

Builds the final endpoint URL based on the passed parameters

Parameters​

NameTypeDescription
paramsPartial<Params>The params to add to the request

Returns​

string

The endpoint URL.

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:220

fetcher​

▸ fetcher(url, params, options?): Promise<FetchResponse<R>>

The default fetcher function

The default fetcher function handles authentication headers and errors from the API.

A custom strategy can override this function to run additional logic before or after the fetch call

Parameters​

NameTypeDescription
urlstringThe URL to fetch
paramsPartial<Params>The request params
optionsPartial<FetchOptions>The fetcher options

Returns​

Promise<FetchResponse<R>>

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:290

filterData​

▸ filterData(data, filterOptions?): FetchResponse<R>

Filters the data returned from the API by excluding fields that are not needed in order to reduce +payload size.

Parameters​

NameTypeDescription
dataFetchResponse<R>The data to filter
filterOptions?FilterDataOptions<R>Filter options

Returns​

FetchResponse<R>

The filtered data

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:377

get​

▸ get(params?): Promise<FetchResponse<R>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage​

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters​

NameTypeDescription
paramsPartial<Params>The endpoint params

Returns​

Promise<FetchResponse<R>>

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:442

getAuthHeader​

▸ getAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:256

getCacheKey​

▸ getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters​

NameTypeDescription
paramsPartial<Params>The request params

Returns​

Object

The cache key object

NameType
argsPartial<Params> & { sourceUrl: string }
urlstring

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:407

getDefaultEndpoint​

▸ Abstract getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint +for the strategy

Returns​

string

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:135

getDefaultParams​

▸ getDefaultParams(): Partial<Params>

Returns​

Partial<Params>

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:182

getEndpoint​

▸ getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, +returns the default endpoint

Returns​

string

The current endpoint for the strategy

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:174

getParamsFromURL​

▸ Abstract getParamsFromURL(path, nonUrlParams): Partial<Params>

Returns the supported params from the URL if present.

These params are passed to buildEndpointURL. If the strategy does not support +mapping url params to endpoint params, it should return an empty object.

Parameters​

NameTypeDescription
pathstringThe Path name
nonUrlParamsPartial<Params>The non-url params

Returns​

Partial<Params>

params extracted from the URL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:197

getPreviewAuthHeader​

▸ getPreviewAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:247

getPreviewHeaderName​

▸ getPreviewHeaderName(options?): "X-HeadstartWP-Authorization" | "Authorization"

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

"X-HeadstartWP-Authorization" | "Authorization"

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:241

getQueriedObject​

▸ getQueriedObject(response, params): Object

Parameters​

NameType
responseFetchResponse<E>
paramsPartial<Params>

Returns​

Object

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:365

isMainQuery​

▸ isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters​

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<Params>The non-url params

Returns​

boolean

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:205

normalizeForCache​

▸ normalizeForCache(data, params): NormalizedDataForCache<R, Params>

Normalize data for cache.

Parameters​

NameTypeDescription
dataFetchResponse<R>The fetch response data
paramsPartial<Params>The request params

Returns​

NormalizedDataForCache<R, Params>

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:417

prepareResponse​

▸ prepareResponse(response, params): FetchResponse<R>

Parameters​

NameType
responseFetchResponse<E>
paramsPartial<Params>

Returns​

FetchResponse<R>

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:233

setBaseURL​

▸ setBaseURL(url?): void

Parameters​

NameTypeDefault value
urlundefined | string''

Returns​

void

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:164

setEndpoint​

▸ setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters​

NameTypeDescription
endpointstringThe endpoint to fetch

Returns​

void

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/classes/headstartwp_core.AppSettingsStrategy/index.html b/api/classes/headstartwp_core.AppSettingsStrategy/index.html index d3d7cfece..4d2198a14 100644 --- a/api/classes/headstartwp_core.AppSettingsStrategy/index.html +++ b/api/classes/headstartwp_core.AppSettingsStrategy/index.html @@ -7,18 +7,18 @@ - - + +
Skip to main content

Class: AppSettingsStrategy<T, P>

@headstartwp/core.AppSettingsStrategy

The App Settings strategy is used to fetch the app settings endpoints exposed by the -headless wp plugin

Type parameters​

NameType
Textends AppEntity = AppEntity
Pextends EndpointParams = EndpointParams

Hierarchy​

Constructors​

constructor​

• new AppSettingsStrategy<T, P>(baseURL?, defaultParams?)

The strategy constructor

Type parameters​

NameType
Textends AppEntity = AppEntity
Pextends EndpointParams = EndpointParams

Parameters​

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from​

AbstractFetchStrategy.constructor

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:143

Properties​

baseURL​

• baseURL: string = ''

The base URL where the API is located

Inherited from​

AbstractFetchStrategy.baseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

defaultParams​

• defaultParams: Partial<P> = {}

The Default Params

Inherited from​

AbstractFetchStrategy.defaultParams

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:119

endpoint​

• endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from​

AbstractFetchStrategy.endpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:124

Methods​

buildEndpointURL​

▸ buildEndpointURL(params): string

Builds the final endpoint URL based on the passed parameters

Parameters​

NameTypeDescription
paramsPartial<P>The params to add to the request

Returns​

string

The endpoint URL.

Inherited from​

AbstractFetchStrategy.buildEndpointURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:220

fetcher​

▸ fetcher(url, params, options?): Promise<FetchResponse<T>>

The default fetcher function

The default fetcher function handles authentication headers and errors from the API.

A custom strategy can override this function to run additional logic before or after the fetch call

Parameters​

NameTypeDescription
urlstringThe URL to fetch
paramsPartial<P>The request params
optionsPartial<FetchOptions>The fetcher options

Returns​

Promise<FetchResponse<T>>

Inherited from​

AbstractFetchStrategy.fetcher

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:290

filterData​

▸ filterData(data, filterOptions?): FetchResponse<T>

Filters the data returned from the API by excluding fields that are not needed in order to reduce -payload size.

Parameters​

NameTypeDescription
dataFetchResponse<T>The data to filter
filterOptions?FilterDataOptions<T>Filter options

Returns​

FetchResponse<T>

The filtered data

Inherited from​

AbstractFetchStrategy.filterData

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:377

get​

▸ get(params?): Promise<FetchResponse<T>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage​

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters​

NameTypeDescription
paramsPartial<P>The endpoint params

Returns​

Promise<FetchResponse<T>>

Inherited from​

AbstractFetchStrategy.get

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:442

getAuthHeader​

▸ getAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

AbstractFetchStrategy.getAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:256

getCacheKey​

▸ getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters​

NameTypeDescription
paramsPartial<P>The request params

Returns​

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from​

AbstractFetchStrategy.getCacheKey

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:407

getDefaultEndpoint​

▸ getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint -for the strategy

Returns​

string

Overrides​

AbstractFetchStrategy.getDefaultEndpoint

Defined in​

packages/core/src/data/strategies/AppSettingsStrategy.ts:15

getDefaultParams​

▸ getDefaultParams(): Partial<P>

Returns​

Partial<P>

Inherited from​

AbstractFetchStrategy.getDefaultParams

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:182

getEndpoint​

▸ getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, -returns the default endpoint

Returns​

string

The current endpoint for the strategy

Inherited from​

AbstractFetchStrategy.getEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:174

getParamsFromURL​

▸ getParamsFromURL(path, params?): Partial<P>

Returns the supported params from the URL if present.

These params are passed to buildEndpointURL. If the strategy does not support -mapping url params to endpoint params, it should return an empty object.

Parameters​

NameTypeDescription
pathstringThe Path name
paramsPartial<P>The non-url params

Returns​

Partial<P>

params extracted from the URL

Overrides​

AbstractFetchStrategy.getParamsFromURL

Defined in​

packages/core/src/data/strategies/AppSettingsStrategy.ts:20

getPreviewAuthHeader​

▸ getPreviewAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

AbstractFetchStrategy.getPreviewAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:247

getPreviewHeaderName​

▸ getPreviewHeaderName(options?): "X-HeadstartWP-Authorization" | "Authorization"

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

"X-HeadstartWP-Authorization" | "Authorization"

Inherited from​

AbstractFetchStrategy.getPreviewHeaderName

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:241

getQueriedObject​

▸ getQueriedObject(response, params): Object

Parameters​

NameType
responseFetchResponse<T>
paramsPartial<P>

Returns​

Object

Inherited from​

AbstractFetchStrategy.getQueriedObject

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:365

isMainQuery​

▸ isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters​

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns​

boolean

Inherited from​

AbstractFetchStrategy.isMainQuery

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:205

normalizeForCache​

▸ normalizeForCache(data, params): NormalizedDataForCache<T, P>

Normalize data for cache.

Parameters​

NameTypeDescription
dataFetchResponse<T>The fetch response data
paramsPartial<P>The request params

Returns​

NormalizedDataForCache<T, P>

Inherited from​

AbstractFetchStrategy.normalizeForCache

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:417

prepareResponse​

▸ prepareResponse(response, params): FetchResponse<T>

Parameters​

NameType
responseFetchResponse<T>
paramsPartial<P>

Returns​

FetchResponse<T>

Inherited from​

AbstractFetchStrategy.prepareResponse

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:233

setBaseURL​

▸ setBaseURL(url?): void

Parameters​

NameTypeDefault value
urlundefined | string''

Returns​

void

Inherited from​

AbstractFetchStrategy.setBaseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:164

setEndpoint​

▸ setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters​

NameTypeDescription
endpointstringThe endpoint to fetch

Returns​

void

Inherited from​

AbstractFetchStrategy.setEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +headless wp plugin

Type parameters​

NameType
Textends AppEntity = AppEntity
Pextends EndpointParams = EndpointParams

Hierarchy​

Constructors​

constructor​

• new AppSettingsStrategy<T, P>(baseURL?, defaultParams?)

The strategy constructor

Type parameters​

NameType
Textends AppEntity = AppEntity
Pextends EndpointParams = EndpointParams

Parameters​

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from​

AbstractFetchStrategy.constructor

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:143

Properties​

baseURL​

• baseURL: string = ''

The base URL where the API is located

Inherited from​

AbstractFetchStrategy.baseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

defaultParams​

• defaultParams: Partial<P> = {}

The Default Params

Inherited from​

AbstractFetchStrategy.defaultParams

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:119

endpoint​

• endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from​

AbstractFetchStrategy.endpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:124

Methods​

buildEndpointURL​

▸ buildEndpointURL(params): string

Builds the final endpoint URL based on the passed parameters

Parameters​

NameTypeDescription
paramsPartial<P>The params to add to the request

Returns​

string

The endpoint URL.

Inherited from​

AbstractFetchStrategy.buildEndpointURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:220

fetcher​

▸ fetcher(url, params, options?): Promise<FetchResponse<T>>

The default fetcher function

The default fetcher function handles authentication headers and errors from the API.

A custom strategy can override this function to run additional logic before or after the fetch call

Parameters​

NameTypeDescription
urlstringThe URL to fetch
paramsPartial<P>The request params
optionsPartial<FetchOptions>The fetcher options

Returns​

Promise<FetchResponse<T>>

Inherited from​

AbstractFetchStrategy.fetcher

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:290

filterData​

▸ filterData(data, filterOptions?): FetchResponse<T>

Filters the data returned from the API by excluding fields that are not needed in order to reduce +payload size.

Parameters​

NameTypeDescription
dataFetchResponse<T>The data to filter
filterOptions?FilterDataOptions<T>Filter options

Returns​

FetchResponse<T>

The filtered data

Inherited from​

AbstractFetchStrategy.filterData

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:377

get​

▸ get(params?): Promise<FetchResponse<T>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage​

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters​

NameTypeDescription
paramsPartial<P>The endpoint params

Returns​

Promise<FetchResponse<T>>

Inherited from​

AbstractFetchStrategy.get

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:442

getAuthHeader​

▸ getAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

AbstractFetchStrategy.getAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:256

getCacheKey​

▸ getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters​

NameTypeDescription
paramsPartial<P>The request params

Returns​

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from​

AbstractFetchStrategy.getCacheKey

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:407

getDefaultEndpoint​

▸ getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint +for the strategy

Returns​

string

Overrides​

AbstractFetchStrategy.getDefaultEndpoint

Defined in​

packages/core/src/data/strategies/AppSettingsStrategy.ts:15

getDefaultParams​

▸ getDefaultParams(): Partial<P>

Returns​

Partial<P>

Inherited from​

AbstractFetchStrategy.getDefaultParams

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:182

getEndpoint​

▸ getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, +returns the default endpoint

Returns​

string

The current endpoint for the strategy

Inherited from​

AbstractFetchStrategy.getEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:174

getParamsFromURL​

▸ getParamsFromURL(path, params?): Partial<P>

Returns the supported params from the URL if present.

These params are passed to buildEndpointURL. If the strategy does not support +mapping url params to endpoint params, it should return an empty object.

Parameters​

NameTypeDescription
pathstringThe Path name
paramsPartial<P>The non-url params

Returns​

Partial<P>

params extracted from the URL

Overrides​

AbstractFetchStrategy.getParamsFromURL

Defined in​

packages/core/src/data/strategies/AppSettingsStrategy.ts:20

getPreviewAuthHeader​

▸ getPreviewAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

AbstractFetchStrategy.getPreviewAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:247

getPreviewHeaderName​

▸ getPreviewHeaderName(options?): "X-HeadstartWP-Authorization" | "Authorization"

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

"X-HeadstartWP-Authorization" | "Authorization"

Inherited from​

AbstractFetchStrategy.getPreviewHeaderName

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:241

getQueriedObject​

▸ getQueriedObject(response, params): Object

Parameters​

NameType
responseFetchResponse<T>
paramsPartial<P>

Returns​

Object

Inherited from​

AbstractFetchStrategy.getQueriedObject

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:365

isMainQuery​

▸ isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters​

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns​

boolean

Inherited from​

AbstractFetchStrategy.isMainQuery

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:205

normalizeForCache​

▸ normalizeForCache(data, params): NormalizedDataForCache<T, P>

Normalize data for cache.

Parameters​

NameTypeDescription
dataFetchResponse<T>The fetch response data
paramsPartial<P>The request params

Returns​

NormalizedDataForCache<T, P>

Inherited from​

AbstractFetchStrategy.normalizeForCache

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:417

prepareResponse​

▸ prepareResponse(response, params): FetchResponse<T>

Parameters​

NameType
responseFetchResponse<T>
paramsPartial<P>

Returns​

FetchResponse<T>

Inherited from​

AbstractFetchStrategy.prepareResponse

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:233

setBaseURL​

▸ setBaseURL(url?): void

Parameters​

NameTypeDefault value
urlundefined | string''

Returns​

void

Inherited from​

AbstractFetchStrategy.setBaseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:164

setEndpoint​

▸ setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters​

NameTypeDescription
endpointstringThe endpoint to fetch

Returns​

void

Inherited from​

AbstractFetchStrategy.setEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/index.html b/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/index.html index 354318770..ac6057186 100644 --- a/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/index.html +++ b/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/index.html @@ -7,17 +7,17 @@ - - + +
-
Skip to main content

Class: AuthorArchiveFetchStrategy<T, P>

@headstartwp/core.AuthorArchiveFetchStrategy

The AuthorArchiveFetchStrategy extends the PostsArchiveFetchStrategy and performs author archive requests

This strategy supports extracting endpoint params from url E.g:

  • /author-name/ maps to { author: 'author-name' }
  • /author-name/page/2 maps to { author: 'author-name', page: 2 }

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Hierarchy​

Constructors​

constructor​

• new AuthorArchiveFetchStrategy<T, P>(baseURL?, defaultParams?)

The strategy constructor

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters​

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from​

PostsArchiveFetchStrategy.constructor

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:143

Properties​

baseURL​

• baseURL: string = ''

The base URL where the API is located

Inherited from​

PostsArchiveFetchStrategy.baseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

defaultParams​

• defaultParams: Partial<P> = {}

The Default Params

Inherited from​

PostsArchiveFetchStrategy.defaultParams

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:119

endpoint​

• endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from​

PostsArchiveFetchStrategy.endpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:124

locale​

• locale: string = ''

Inherited from​

PostsArchiveFetchStrategy.locale

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:212

path​

• path: string = ''

Inherited from​

PostsArchiveFetchStrategy.path

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:210

Methods​

buildEndpointURL​

▸ buildEndpointURL(params): string

Handles taxonomy filters and switch endpoint based on post type

Parameters​

NameTypeDescription
paramsPartial<P>The params to build the endpoint with

Returns​

string

Inherited from​

PostsArchiveFetchStrategy.buildEndpointURL

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:289

fetcher​

▸ fetcher(url, params, options?): Promise<FetchResponse<T[]>>

Before fetching posts, we need handle taxonomy and authors.

If the headless plugin is not being used, then additional requests needs to be made to get -authors and terms ids

Parameters​

NameTypeDescription
urlstringThe URL to parse
paramsPartial<P>The params to build the endpoint with
optionsPartial<FetchOptions>FetchOptions

Returns​

Promise<FetchResponse<T[]>>

Inherited from​

PostsArchiveFetchStrategy.fetcher

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:393

filterData​

▸ filterData(data, options?): FetchResponse<T[]>

Filters the data returned from the API by excluding fields that are not needed in order to reduce -payload size.

Parameters​

NameTypeDescription
dataFetchResponse<T[]>The data to filter
options?FilterDataOptions<T[]>Filter options

Returns​

FetchResponse<T[]>

The filtered data

Inherited from​

PostsArchiveFetchStrategy.filterData

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:530

get​

▸ get(params?): Promise<FetchResponse<T[]>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage​

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters​

NameTypeDescription
paramsPartial<P>The endpoint params

Returns​

Promise<FetchResponse<T[]>>

Inherited from​

PostsArchiveFetchStrategy.get

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:442

getAuthHeader​

▸ getAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

PostsArchiveFetchStrategy.getAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:256

getCacheKey​

▸ getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters​

NameTypeDescription
paramsPartial<P>The request params

Returns​

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from​

PostsArchiveFetchStrategy.getCacheKey

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:407

getDefaultEndpoint​

▸ getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint -for the strategy

Returns​

string

Inherited from​

PostsArchiveFetchStrategy.getDefaultEndpoint

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:214

getDefaultParams​

▸ getDefaultParams(): Partial<P>

Returns​

Partial<P>

Inherited from​

PostsArchiveFetchStrategy.getDefaultParams

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:218

getEndpoint​

▸ getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, -returns the default endpoint

Returns​

string

The current endpoint for the strategy

Inherited from​

PostsArchiveFetchStrategy.getEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:174

getParamsFromURL​

▸ getParamsFromURL(path, nonUrlParams?): Partial<P>

This strategy automatically extracts taxonomy filters, date filters and pagination params from the URL

It also takes into account the custom taxonomies specified in headless.config.js

Parameters​

NameTypeDescription
pathstringThe URL path to extract params from
nonUrlParamsPartial<P>

Returns​

Partial<P>

Overrides​

PostsArchiveFetchStrategy.getParamsFromURL

Defined in​

packages/core/src/data/strategies/AuthorArchiveFetchStrategy.ts:20

getPreviewAuthHeader​

▸ getPreviewAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

PostsArchiveFetchStrategy.getPreviewAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:247

getPreviewHeaderName​

▸ getPreviewHeaderName(options?): "X-HeadstartWP-Authorization" | "Authorization"

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

"X-HeadstartWP-Authorization" | "Authorization"

Inherited from​

PostsArchiveFetchStrategy.getPreviewHeaderName

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:241

getQueriedObject​

▸ getQueriedObject(response, params): QueriedObject

Returns the queried object if applicable (e.g if querying by category, tag, author or custom taxonomy term)

Parameters​

NameTypeDescription
responseFetchResponse<T[]>The response from the API
paramsPartial<P>The request params

Returns​

QueriedObject

Inherited from​

PostsArchiveFetchStrategy.getQueriedObject

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:461

isMainQuery​

▸ isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters​

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns​

boolean

Inherited from​

PostsArchiveFetchStrategy.isMainQuery

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:205

normalizeForCache​

▸ normalizeForCache(data, params): NormalizedDataForCache<T[], P>

Normalize data for cache.

Parameters​

NameTypeDescription
dataFetchResponse<T[]>The fetch response data
paramsPartial<P>The request params

Returns​

NormalizedDataForCache<T[], P>

Inherited from​

PostsArchiveFetchStrategy.normalizeForCache

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:417

prepareResponse​

▸ prepareResponse(response, params): FetchResponse<T[]>

Parameters​

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns​

FetchResponse<T[]>

Inherited from​

PostsArchiveFetchStrategy.prepareResponse

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:327

setBaseURL​

▸ setBaseURL(url?): void

Parameters​

NameTypeDefault value
urlundefined | string''

Returns​

void

Inherited from​

PostsArchiveFetchStrategy.setBaseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:164

setEndpoint​

▸ setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters​

NameTypeDescription
endpointstringThe endpoint to fetch

Returns​

void

Inherited from​

PostsArchiveFetchStrategy.setEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Class: AuthorArchiveFetchStrategy<T, P>

@headstartwp/core.AuthorArchiveFetchStrategy

The AuthorArchiveFetchStrategy extends the PostsArchiveFetchStrategy and performs author archive requests

This strategy supports extracting endpoint params from url E.g:

  • /author-name/ maps to { author: 'author-name' }
  • /author-name/page/2 maps to { author: 'author-name', page: 2 }

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Hierarchy​

Constructors​

constructor​

• new AuthorArchiveFetchStrategy<T, P>(baseURL?, defaultParams?)

The strategy constructor

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters​

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from​

PostsArchiveFetchStrategy.constructor

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:143

Properties​

baseURL​

• baseURL: string = ''

The base URL where the API is located

Inherited from​

PostsArchiveFetchStrategy.baseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

defaultParams​

• defaultParams: Partial<P> = {}

The Default Params

Inherited from​

PostsArchiveFetchStrategy.defaultParams

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:119

endpoint​

• endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from​

PostsArchiveFetchStrategy.endpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:124

locale​

• locale: string = ''

Inherited from​

PostsArchiveFetchStrategy.locale

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:212

path​

• path: string = ''

Inherited from​

PostsArchiveFetchStrategy.path

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:210

Methods​

buildEndpointURL​

▸ buildEndpointURL(params): string

Handles taxonomy filters and switch endpoint based on post type

Parameters​

NameTypeDescription
paramsPartial<P>The params to build the endpoint with

Returns​

string

Inherited from​

PostsArchiveFetchStrategy.buildEndpointURL

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:289

fetcher​

▸ fetcher(url, params, options?): Promise<FetchResponse<T[]>>

Before fetching posts, we need handle taxonomy and authors.

If the headless plugin is not being used, then additional requests needs to be made to get +authors and terms ids

Parameters​

NameTypeDescription
urlstringThe URL to parse
paramsPartial<P>The params to build the endpoint with
optionsPartial<FetchOptions>FetchOptions

Returns​

Promise<FetchResponse<T[]>>

Inherited from​

PostsArchiveFetchStrategy.fetcher

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:393

filterData​

▸ filterData(data, options?): FetchResponse<T[]>

Filters the data returned from the API by excluding fields that are not needed in order to reduce +payload size.

Parameters​

NameTypeDescription
dataFetchResponse<T[]>The data to filter
options?FilterDataOptions<T[]>Filter options

Returns​

FetchResponse<T[]>

The filtered data

Inherited from​

PostsArchiveFetchStrategy.filterData

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:530

get​

▸ get(params?): Promise<FetchResponse<T[]>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage​

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters​

NameTypeDescription
paramsPartial<P>The endpoint params

Returns​

Promise<FetchResponse<T[]>>

Inherited from​

PostsArchiveFetchStrategy.get

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:442

getAuthHeader​

▸ getAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

PostsArchiveFetchStrategy.getAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:256

getCacheKey​

▸ getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters​

NameTypeDescription
paramsPartial<P>The request params

Returns​

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from​

PostsArchiveFetchStrategy.getCacheKey

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:407

getDefaultEndpoint​

▸ getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint +for the strategy

Returns​

string

Inherited from​

PostsArchiveFetchStrategy.getDefaultEndpoint

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:214

getDefaultParams​

▸ getDefaultParams(): Partial<P>

Returns​

Partial<P>

Inherited from​

PostsArchiveFetchStrategy.getDefaultParams

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:218

getEndpoint​

▸ getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, +returns the default endpoint

Returns​

string

The current endpoint for the strategy

Inherited from​

PostsArchiveFetchStrategy.getEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:174

getParamsFromURL​

▸ getParamsFromURL(path, nonUrlParams?): Partial<P>

This strategy automatically extracts taxonomy filters, date filters and pagination params from the URL

It also takes into account the custom taxonomies specified in headless.config.js

Parameters​

NameTypeDescription
pathstringThe URL path to extract params from
nonUrlParamsPartial<P>

Returns​

Partial<P>

Overrides​

PostsArchiveFetchStrategy.getParamsFromURL

Defined in​

packages/core/src/data/strategies/AuthorArchiveFetchStrategy.ts:20

getPreviewAuthHeader​

▸ getPreviewAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

PostsArchiveFetchStrategy.getPreviewAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:247

getPreviewHeaderName​

▸ getPreviewHeaderName(options?): "X-HeadstartWP-Authorization" | "Authorization"

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

"X-HeadstartWP-Authorization" | "Authorization"

Inherited from​

PostsArchiveFetchStrategy.getPreviewHeaderName

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:241

getQueriedObject​

▸ getQueriedObject(response, params): QueriedObject

Returns the queried object if applicable (e.g if querying by category, tag, author or custom taxonomy term)

Parameters​

NameTypeDescription
responseFetchResponse<T[]>The response from the API
paramsPartial<P>The request params

Returns​

QueriedObject

Inherited from​

PostsArchiveFetchStrategy.getQueriedObject

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:461

isMainQuery​

▸ isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters​

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns​

boolean

Inherited from​

PostsArchiveFetchStrategy.isMainQuery

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:205

normalizeForCache​

▸ normalizeForCache(data, params): NormalizedDataForCache<T[], P>

Normalize data for cache.

Parameters​

NameTypeDescription
dataFetchResponse<T[]>The fetch response data
paramsPartial<P>The request params

Returns​

NormalizedDataForCache<T[], P>

Inherited from​

PostsArchiveFetchStrategy.normalizeForCache

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:417

prepareResponse​

▸ prepareResponse(response, params): FetchResponse<T[]>

Parameters​

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns​

FetchResponse<T[]>

Inherited from​

PostsArchiveFetchStrategy.prepareResponse

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:327

setBaseURL​

▸ setBaseURL(url?): void

Parameters​

NameTypeDefault value
urlundefined | string''

Returns​

void

Inherited from​

PostsArchiveFetchStrategy.setBaseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:164

setEndpoint​

▸ setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters​

NameTypeDescription
endpointstringThe endpoint to fetch

Returns​

void

Inherited from​

PostsArchiveFetchStrategy.setEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/classes/headstartwp_core.Comment/index.html b/api/classes/headstartwp_core.Comment/index.html index da6e2bd61..d51e940e6 100644 --- a/api/classes/headstartwp_core.Comment/index.html +++ b/api/classes/headstartwp_core.Comment/index.html @@ -7,8 +7,8 @@ - - + +
@@ -17,7 +17,7 @@ DOM spec-compatible alias.

Returns​

string

Inherited from​

DataNode.nodeValue

Defined in​

node_modules/domhandler/lib/node.d.ts:90

• set nodeValue(data): void

Parameters​

NameType
datastring

Returns​

void

Inherited from​

DataNode.nodeValue

Defined in​

node_modules/domhandler/lib/node.d.ts:91

parentNode​

• get parentNode(): null | ParentNode

Same as parent. DOM spec-compatible alias.

Returns​

null | ParentNode

Inherited from​

DataNode.parentNode

Defined in​

node_modules/domhandler/lib/node.d.ts:55

• set parentNode(parent): void

Parameters​

NameType
parentnull | ParentNode

Returns​

void

Inherited from​

DataNode.parentNode

Defined in​

node_modules/domhandler/lib/node.d.ts:56

previousSibling​

• get previousSibling(): null | ChildNode

Same as prev. DOM spec-compatible alias.

Returns​

null | ChildNode

Inherited from​

DataNode.previousSibling

Defined in​

node_modules/domhandler/lib/node.d.ts:61

• set previousSibling(prev): void

Parameters​

NameType
prevnull | ChildNode

Returns​

void

Inherited from​

DataNode.previousSibling

Defined in​

node_modules/domhandler/lib/node.d.ts:62

Methods​

cloneNode​

▸ cloneNode<T>(this, recursive?): T

Clone this node, and optionally its children.

Type parameters​

NameType
Textends Node<T>

Parameters​

NameTypeDescription
thisT-
recursive?booleanClone child nodes as well.

Returns​

T

A clone of the node.

Inherited from​

DataNode.cloneNode

Defined in​

node_modules/domhandler/lib/node.d.ts:75

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - + + \ No newline at end of file diff --git a/api/classes/headstartwp_core.ConfigError/index.html b/api/classes/headstartwp_core.ConfigError/index.html index 8d6fbf5fb..a7b81fd22 100644 --- a/api/classes/headstartwp_core.ConfigError/index.html +++ b/api/classes/headstartwp_core.ConfigError/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Class: ConfigError

@headstartwp/core.ConfigError

Hierarchy​

  • Error

    ↳ ConfigError

Constructors​

constructor​

• new ConfigError(message)

Parameters​

NameType
messagestring

Overrides​

Error.constructor

Defined in​

packages/core/src/utils/errors.ts:18

Properties​

cause​

• Optional cause: unknown

Inherited from​

Error.cause

Defined in​

docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26

message​

• message: string

Inherited from​

Error.message

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1054

name​

• name: string

Inherited from​

Error.name

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1053

stack​

• Optional stack: string

Inherited from​

Error.stack

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1055

node_modules/@types/node/globals.d.ts:127

prepareStackTrace​

▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration​

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces

Parameters​
NameType
errError
stackTracesCallSite[]
Returns​

any

Inherited from​

Error.prepareStackTrace

Defined in​

node_modules/@types/node/globals.d.ts:140

stackTraceLimit​

▪ Static stackTraceLimit: number

Inherited from​

Error.stackTraceLimit

Defined in​

node_modules/@types/node/globals.d.ts:142

Methods​

captureStackTrace​

▸ Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters​

NameType
targetObjectObject
constructorOpt?Function

Returns​

void

Inherited from​

Error.captureStackTrace

Defined in​

node_modules/@types/node/globals.d.ts:133

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Class: ConfigError

@headstartwp/core.ConfigError

Hierarchy​

  • Error

    ↳ ConfigError

Constructors​

constructor​

• new ConfigError(message)

Parameters​

NameType
messagestring

Overrides​

Error.constructor

Defined in​

packages/core/src/utils/errors.ts:18

Properties​

cause​

• Optional cause: unknown

Inherited from​

Error.cause

Defined in​

docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26

message​

• message: string

Inherited from​

Error.message

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1054

name​

• name: string

Inherited from​

Error.name

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1053

stack​

• Optional stack: string

Inherited from​

Error.stack

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1055

node_modules/@types/node/globals.d.ts:127

prepareStackTrace​

▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration​

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces

Parameters​
NameType
errError
stackTracesCallSite[]
Returns​

any

Inherited from​

Error.prepareStackTrace

Defined in​

node_modules/@types/node/globals.d.ts:140

stackTraceLimit​

▪ Static stackTraceLimit: number

Inherited from​

Error.stackTraceLimit

Defined in​

node_modules/@types/node/globals.d.ts:142

Methods​

captureStackTrace​

▸ Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters​

NameType
targetObjectObject
constructorOpt?Function

Returns​

void

Inherited from​

Error.captureStackTrace

Defined in​

node_modules/@types/node/globals.d.ts:133

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/classes/headstartwp_core.Element/index.html b/api/classes/headstartwp_core.Element/index.html index 1beb73368..256a2b075 100644 --- a/api/classes/headstartwp_core.Element/index.html +++ b/api/classes/headstartwp_core.Element/index.html @@ -7,8 +7,8 @@ - - + +
@@ -18,7 +18,7 @@ DOM spec-compatible alias.

Returns​

null | ParentNode

Inherited from​

NodeWithChildren.parentNode

Defined in​

node_modules/domhandler/lib/node.d.ts:55

• set parentNode(parent): void

Parameters​

NameType
parentnull | ParentNode

Returns​

void

Inherited from​

NodeWithChildren.parentNode

Defined in​

node_modules/domhandler/lib/node.d.ts:56

previousSibling​

• get previousSibling(): null | ChildNode

Same as prev. DOM spec-compatible alias.

Returns​

null | ChildNode

Inherited from​

NodeWithChildren.previousSibling

Defined in​

node_modules/domhandler/lib/node.d.ts:61

• set previousSibling(prev): void

Parameters​

NameType
prevnull | ChildNode

Returns​

void

Inherited from​

NodeWithChildren.previousSibling

Defined in​

node_modules/domhandler/lib/node.d.ts:62

tagName​

• get tagName(): string

Same as name. DOM spec-compatible alias.

Returns​

string

Defined in​

node_modules/domhandler/lib/node.d.ts:192

• set tagName(name): void

Parameters​

NameType
namestring

Returns​

void

Defined in​

node_modules/domhandler/lib/node.d.ts:193

Methods​

cloneNode​

▸ cloneNode<T>(this, recursive?): T

Clone this node, and optionally its children.

Type parameters​

NameType
Textends Node<T>

Parameters​

NameTypeDescription
thisT-
recursive?booleanClone child nodes as well.

Returns​

T

A clone of the node.

Inherited from​

NodeWithChildren.cloneNode

Defined in​

node_modules/domhandler/lib/node.d.ts:75

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - + + \ No newline at end of file diff --git a/api/classes/headstartwp_core.EndpointError/index.html b/api/classes/headstartwp_core.EndpointError/index.html index 5da04ca92..d6c1137ea 100644 --- a/api/classes/headstartwp_core.EndpointError/index.html +++ b/api/classes/headstartwp_core.EndpointError/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Class: EndpointError

@headstartwp/core.EndpointError

Hierarchy​

  • Error

    ↳ EndpointError

Constructors​

constructor​

• new EndpointError(message)

Parameters​

NameType
messagestring

Overrides​

Error.constructor

Defined in​

packages/core/src/utils/errors.ts:25

Properties​

cause​

• Optional cause: unknown

Inherited from​

Error.cause

Defined in​

docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26

message​

• message: string

Inherited from​

Error.message

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1054

name​

• name: string

Inherited from​

Error.name

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1053

stack​

• Optional stack: string

Inherited from​

Error.stack

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1055

node_modules/@types/node/globals.d.ts:127

prepareStackTrace​

▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration​

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces

Parameters​
NameType
errError
stackTracesCallSite[]
Returns​

any

Inherited from​

Error.prepareStackTrace

Defined in​

node_modules/@types/node/globals.d.ts:140

stackTraceLimit​

▪ Static stackTraceLimit: number

Inherited from​

Error.stackTraceLimit

Defined in​

node_modules/@types/node/globals.d.ts:142

Methods​

captureStackTrace​

▸ Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters​

NameType
targetObjectObject
constructorOpt?Function

Returns​

void

Inherited from​

Error.captureStackTrace

Defined in​

node_modules/@types/node/globals.d.ts:133

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Class: EndpointError

@headstartwp/core.EndpointError

Hierarchy​

  • Error

    ↳ EndpointError

Constructors​

constructor​

• new EndpointError(message)

Parameters​

NameType
messagestring

Overrides​

Error.constructor

Defined in​

packages/core/src/utils/errors.ts:25

Properties​

cause​

• Optional cause: unknown

Inherited from​

Error.cause

Defined in​

docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26

message​

• message: string

Inherited from​

Error.message

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1054

name​

• name: string

Inherited from​

Error.name

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1053

stack​

• Optional stack: string

Inherited from​

Error.stack

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1055

node_modules/@types/node/globals.d.ts:127

prepareStackTrace​

▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration​

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces

Parameters​
NameType
errError
stackTracesCallSite[]
Returns​

any

Inherited from​

Error.prepareStackTrace

Defined in​

node_modules/@types/node/globals.d.ts:140

stackTraceLimit​

▪ Static stackTraceLimit: number

Inherited from​

Error.stackTraceLimit

Defined in​

node_modules/@types/node/globals.d.ts:142

Methods​

captureStackTrace​

▸ Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters​

NameType
targetObjectObject
constructorOpt?Function

Returns​

void

Inherited from​

Error.captureStackTrace

Defined in​

node_modules/@types/node/globals.d.ts:133

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/classes/headstartwp_core.FetchError/index.html b/api/classes/headstartwp_core.FetchError/index.html index 429d60790..cf30204ba 100644 --- a/api/classes/headstartwp_core.FetchError/index.html +++ b/api/classes/headstartwp_core.FetchError/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Class: FetchError

@headstartwp/core.FetchError

Hierarchy​

  • Error

    ↳ FetchError

Constructors​

constructor​

• new FetchError(message)

Parameters​

NameType
messagestring

Overrides​

Error.constructor

Defined in​

packages/core/src/utils/errors.ts:11

Properties​

cause​

• Optional cause: unknown

Inherited from​

Error.cause

Defined in​

docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26

message​

• message: string

Inherited from​

Error.message

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1054

name​

• name: string

Inherited from​

Error.name

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1053

stack​

• Optional stack: string

Inherited from​

Error.stack

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1055

node_modules/@types/node/globals.d.ts:127

prepareStackTrace​

▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration​

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces

Parameters​
NameType
errError
stackTracesCallSite[]
Returns​

any

Inherited from​

Error.prepareStackTrace

Defined in​

node_modules/@types/node/globals.d.ts:140

stackTraceLimit​

▪ Static stackTraceLimit: number

Inherited from​

Error.stackTraceLimit

Defined in​

node_modules/@types/node/globals.d.ts:142

Methods​

captureStackTrace​

▸ Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters​

NameType
targetObjectObject
constructorOpt?Function

Returns​

void

Inherited from​

Error.captureStackTrace

Defined in​

node_modules/@types/node/globals.d.ts:133

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Class: FetchError

@headstartwp/core.FetchError

Hierarchy​

  • Error

    ↳ FetchError

Constructors​

constructor​

• new FetchError(message)

Parameters​

NameType
messagestring

Overrides​

Error.constructor

Defined in​

packages/core/src/utils/errors.ts:11

Properties​

cause​

• Optional cause: unknown

Inherited from​

Error.cause

Defined in​

docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26

message​

• message: string

Inherited from​

Error.message

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1054

name​

• name: string

Inherited from​

Error.name

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1053

stack​

• Optional stack: string

Inherited from​

Error.stack

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1055

node_modules/@types/node/globals.d.ts:127

prepareStackTrace​

▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration​

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces

Parameters​
NameType
errError
stackTracesCallSite[]
Returns​

any

Inherited from​

Error.prepareStackTrace

Defined in​

node_modules/@types/node/globals.d.ts:140

stackTraceLimit​

▪ Static stackTraceLimit: number

Inherited from​

Error.stackTraceLimit

Defined in​

node_modules/@types/node/globals.d.ts:142

Methods​

captureStackTrace​

▸ Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters​

NameType
targetObjectObject
constructorOpt?Function

Returns​

void

Inherited from​

Error.captureStackTrace

Defined in​

node_modules/@types/node/globals.d.ts:133

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/classes/headstartwp_core.FrameworkError/index.html b/api/classes/headstartwp_core.FrameworkError/index.html index e36795aab..6c6e86533 100644 --- a/api/classes/headstartwp_core.FrameworkError/index.html +++ b/api/classes/headstartwp_core.FrameworkError/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Class: FrameworkError

@headstartwp/core.FrameworkError

Hierarchy​

  • Error

    ↳ FrameworkError

Constructors​

constructor​

• new FrameworkError(message)

Parameters​

NameType
messagestring

Overrides​

Error.constructor

Defined in​

packages/core/src/utils/errors.ts:32

Properties​

cause​

• Optional cause: unknown

Inherited from​

Error.cause

Defined in​

docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26

message​

• message: string

Inherited from​

Error.message

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1054

name​

• name: string

Inherited from​

Error.name

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1053

stack​

• Optional stack: string

Inherited from​

Error.stack

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1055

node_modules/@types/node/globals.d.ts:127

prepareStackTrace​

▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration​

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces

Parameters​
NameType
errError
stackTracesCallSite[]
Returns​

any

Inherited from​

Error.prepareStackTrace

Defined in​

node_modules/@types/node/globals.d.ts:140

stackTraceLimit​

▪ Static stackTraceLimit: number

Inherited from​

Error.stackTraceLimit

Defined in​

node_modules/@types/node/globals.d.ts:142

Methods​

captureStackTrace​

▸ Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters​

NameType
targetObjectObject
constructorOpt?Function

Returns​

void

Inherited from​

Error.captureStackTrace

Defined in​

node_modules/@types/node/globals.d.ts:133

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Class: FrameworkError

@headstartwp/core.FrameworkError

Hierarchy​

  • Error

    ↳ FrameworkError

Constructors​

constructor​

• new FrameworkError(message)

Parameters​

NameType
messagestring

Overrides​

Error.constructor

Defined in​

packages/core/src/utils/errors.ts:32

Properties​

cause​

• Optional cause: unknown

Inherited from​

Error.cause

Defined in​

docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26

message​

• message: string

Inherited from​

Error.message

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1054

name​

• name: string

Inherited from​

Error.name

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1053

stack​

• Optional stack: string

Inherited from​

Error.stack

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1055

node_modules/@types/node/globals.d.ts:127

prepareStackTrace​

▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration​

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces

Parameters​
NameType
errError
stackTracesCallSite[]
Returns​

any

Inherited from​

Error.prepareStackTrace

Defined in​

node_modules/@types/node/globals.d.ts:140

stackTraceLimit​

▪ Static stackTraceLimit: number

Inherited from​

Error.stackTraceLimit

Defined in​

node_modules/@types/node/globals.d.ts:142

Methods​

captureStackTrace​

▸ Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters​

NameType
targetObjectObject
constructorOpt?Function

Returns​

void

Inherited from​

Error.captureStackTrace

Defined in​

node_modules/@types/node/globals.d.ts:133

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/classes/headstartwp_core.NotFoundError/index.html b/api/classes/headstartwp_core.NotFoundError/index.html index 1e22367f0..2511924dc 100644 --- a/api/classes/headstartwp_core.NotFoundError/index.html +++ b/api/classes/headstartwp_core.NotFoundError/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Class: NotFoundError

@headstartwp/core.NotFoundError

Hierarchy​

  • Error

    ↳ NotFoundError

Constructors​

constructor​

• new NotFoundError(message)

Parameters​

NameType
messagestring

Overrides​

Error.constructor

Defined in​

packages/core/src/utils/errors.ts:4

Properties​

cause​

• Optional cause: unknown

Inherited from​

Error.cause

Defined in​

docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26

message​

• message: string

Inherited from​

Error.message

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1054

name​

• name: string

Inherited from​

Error.name

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1053

stack​

• Optional stack: string

Inherited from​

Error.stack

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1055

node_modules/@types/node/globals.d.ts:127

prepareStackTrace​

▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration​

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces

Parameters​
NameType
errError
stackTracesCallSite[]
Returns​

any

Inherited from​

Error.prepareStackTrace

Defined in​

node_modules/@types/node/globals.d.ts:140

stackTraceLimit​

▪ Static stackTraceLimit: number

Inherited from​

Error.stackTraceLimit

Defined in​

node_modules/@types/node/globals.d.ts:142

Methods​

captureStackTrace​

▸ Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters​

NameType
targetObjectObject
constructorOpt?Function

Returns​

void

Inherited from​

Error.captureStackTrace

Defined in​

node_modules/@types/node/globals.d.ts:133

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Class: NotFoundError

@headstartwp/core.NotFoundError

Hierarchy​

  • Error

    ↳ NotFoundError

Constructors​

constructor​

• new NotFoundError(message)

Parameters​

NameType
messagestring

Overrides​

Error.constructor

Defined in​

packages/core/src/utils/errors.ts:4

Properties​

cause​

• Optional cause: unknown

Inherited from​

Error.cause

Defined in​

docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26

message​

• message: string

Inherited from​

Error.message

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1054

name​

• name: string

Inherited from​

Error.name

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1053

stack​

• Optional stack: string

Inherited from​

Error.stack

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1055

node_modules/@types/node/globals.d.ts:127

prepareStackTrace​

▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration​

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces

Parameters​
NameType
errError
stackTracesCallSite[]
Returns​

any

Inherited from​

Error.prepareStackTrace

Defined in​

node_modules/@types/node/globals.d.ts:140

stackTraceLimit​

▪ Static stackTraceLimit: number

Inherited from​

Error.stackTraceLimit

Defined in​

node_modules/@types/node/globals.d.ts:142

Methods​

captureStackTrace​

▸ Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters​

NameType
targetObjectObject
constructorOpt?Function

Returns​

void

Inherited from​

Error.captureStackTrace

Defined in​

node_modules/@types/node/globals.d.ts:133

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/classes/headstartwp_core.PostOrPostsFetchStrategy/index.html b/api/classes/headstartwp_core.PostOrPostsFetchStrategy/index.html index ca7375b42..6155d1685 100644 --- a/api/classes/headstartwp_core.PostOrPostsFetchStrategy/index.html +++ b/api/classes/headstartwp_core.PostOrPostsFetchStrategy/index.html @@ -7,17 +7,17 @@ - - + +
-
Skip to main content

Class: PostOrPostsFetchStrategy<T, P, R>

@headstartwp/core.PostOrPostsFetchStrategy

This fetch strategy does not support extracting url params from the url

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostOrPostsParams = PostOrPostsParams
Rextends PostOrPostsFetchStrategyResult<T> = PostOrPostsFetchStrategyResult<T>

Hierarchy​

Constructors​

constructor​

• new PostOrPostsFetchStrategy<T, P, R>(baseURL?, defaultParams?)

The strategy constructor

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostOrPostsParams = PostOrPostsParams
Rextends PostOrPostsFetchStrategyResult<T> = PostOrPostsFetchStrategyResult<T>

Parameters​

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from​

AbstractFetchStrategy.constructor

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:143

Properties​

baseURL​

• baseURL: string = ''

The base URL where the API is located

Inherited from​

AbstractFetchStrategy.baseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

defaultParams​

• defaultParams: Partial<P> = {}

The Default Params

Inherited from​

AbstractFetchStrategy.defaultParams

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:119

endpoint​

• endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from​

AbstractFetchStrategy.endpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:124

postStrategy​

• postStrategy: SinglePostFetchStrategy<PostEntity, PostParams>

Defined in​

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:60

postsStrategy​

• postsStrategy: PostsArchiveFetchStrategy<PostEntity, PostsArchiveParams>

Defined in​

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:62

urlParams​

• urlParams: Partial<P> = {}

Defined in​

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:58

Methods​

buildEndpointURL​

▸ buildEndpointURL(params): string

Builds the final endpoint URL based on the passed parameters

Parameters​

NameTypeDescription
paramsPartial<P>The params to add to the request

Returns​

string

The endpoint URL.

Inherited from​

AbstractFetchStrategy.buildEndpointURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:220

fetchArchive​

▸ fetchArchive(url, params, options?): Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: R }>

Parameters​

NameType
urlstring
paramsPostsArchiveParams
options?Partial<FetchOptions>

Returns​

Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: R }>

Defined in​

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:145

fetchSingle​

▸ fetchSingle(url, params, options?): Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: R }>

Parameters​

NameType
urlstring
paramsPostParams
options?Partial<FetchOptions>

Returns​

Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: R }>

Defined in​

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:132

fetcher​

▸ fetcher(url, params, options?): Promise<FetchResponse<R>>

The default fetcher function

The default fetcher function handles authentication headers and errors from the API.

A custom strategy can override this function to run additional logic before or after the fetch call

Parameters​

NameTypeDescription
urlstringThe URL to fetch
paramsPartial<P>The request params
options?Partial<FetchOptions>The fetcher options

Returns​

Promise<FetchResponse<R>>

Overrides​

AbstractFetchStrategy.fetcher

Defined in​

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:158

filterData​

▸ filterData(data, filterOptions?): FetchResponse<R>

Filters the data returned from the API by excluding fields that are not needed in order to reduce -payload size.

Parameters​

NameTypeDescription
dataFetchResponse<R>The data to filter
filterOptions?FilterDataOptions<R>Filter options

Returns​

FetchResponse<R>

The filtered data

Inherited from​

AbstractFetchStrategy.filterData

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:377

get​

▸ get(params?): Promise<FetchResponse<R>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage​

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters​

NameTypeDescription
paramsPartial<P>The endpoint params

Returns​

Promise<FetchResponse<R>>

Inherited from​

AbstractFetchStrategy.get

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:442

getAuthHeader​

▸ getAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

AbstractFetchStrategy.getAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:256

getCacheKey​

▸ getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters​

NameTypeDescription
paramsPartial<P>The request params

Returns​

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from​

AbstractFetchStrategy.getCacheKey

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:407

getDefaultEndpoint​

▸ getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint -for the strategy

Returns​

string

Overrides​

AbstractFetchStrategy.getDefaultEndpoint

Defined in​

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:64

getDefaultParams​

▸ getDefaultParams(): Partial<P>

Returns​

Partial<P>

Inherited from​

AbstractFetchStrategy.getDefaultParams

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:182

getEndpoint​

▸ getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, -returns the default endpoint

Returns​

string

The current endpoint for the strategy

Inherited from​

AbstractFetchStrategy.getEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:174

getParamsFromURL​

▸ getParamsFromURL(path, params?): Partial<P>

Returns the supported params from the URL if present.

These params are passed to buildEndpointURL. If the strategy does not support -mapping url params to endpoint params, it should return an empty object.

Parameters​

NameTypeDescription
pathstringThe Path name
paramsPartial<P>The non-url params

Returns​

Partial<P>

params extracted from the URL

Overrides​

AbstractFetchStrategy.getParamsFromURL

Defined in​

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:68

getPreviewAuthHeader​

▸ getPreviewAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

AbstractFetchStrategy.getPreviewAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:247

getPreviewHeaderName​

▸ getPreviewHeaderName(options?): "X-HeadstartWP-Authorization" | "Authorization"

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

"X-HeadstartWP-Authorization" | "Authorization"

Inherited from​

AbstractFetchStrategy.getPreviewHeaderName

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:241

getQueriedObject​

▸ getQueriedObject(response, params): Object

Parameters​

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns​

Object

Inherited from​

AbstractFetchStrategy.getQueriedObject

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:365

isMainQuery​

▸ isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters​

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns​

boolean

Inherited from​

AbstractFetchStrategy.isMainQuery

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:205

normalizeForCache​

▸ normalizeForCache(data, params): NormalizedDataForCache<R, P>

Normalize data for cache.

Parameters​

NameTypeDescription
dataFetchResponse<R>The fetch response data
paramsPartial<P>The request params

Returns​

NormalizedDataForCache<R, P>

Overrides​

AbstractFetchStrategy.normalizeForCache

Defined in​

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:77

prepareResponse​

▸ prepareResponse(response, params): FetchResponse<R>

Parameters​

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns​

FetchResponse<R>

Inherited from​

AbstractFetchStrategy.prepareResponse

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:233

setBaseURL​

▸ setBaseURL(url?): void

Parameters​

NameTypeDefault value
urlundefined | string''

Returns​

void

Inherited from​

AbstractFetchStrategy.setBaseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:164

setEndpoint​

▸ setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters​

NameTypeDescription
endpointstringThe endpoint to fetch

Returns​

void

Inherited from​

AbstractFetchStrategy.setEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Class: PostOrPostsFetchStrategy<T, P, R>

@headstartwp/core.PostOrPostsFetchStrategy

This fetch strategy does not support extracting url params from the url

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostOrPostsParams = PostOrPostsParams
Rextends PostOrPostsFetchStrategyResult<T> = PostOrPostsFetchStrategyResult<T>

Hierarchy​

Constructors​

constructor​

• new PostOrPostsFetchStrategy<T, P, R>(baseURL?, defaultParams?)

The strategy constructor

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostOrPostsParams = PostOrPostsParams
Rextends PostOrPostsFetchStrategyResult<T> = PostOrPostsFetchStrategyResult<T>

Parameters​

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from​

AbstractFetchStrategy.constructor

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:143

Properties​

baseURL​

• baseURL: string = ''

The base URL where the API is located

Inherited from​

AbstractFetchStrategy.baseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

defaultParams​

• defaultParams: Partial<P> = {}

The Default Params

Inherited from​

AbstractFetchStrategy.defaultParams

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:119

endpoint​

• endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from​

AbstractFetchStrategy.endpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:124

postStrategy​

• postStrategy: SinglePostFetchStrategy<PostEntity, PostParams>

Defined in​

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:60

postsStrategy​

• postsStrategy: PostsArchiveFetchStrategy<PostEntity, PostsArchiveParams>

Defined in​

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:62

urlParams​

• urlParams: Partial<P> = {}

Defined in​

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:58

Methods​

buildEndpointURL​

▸ buildEndpointURL(params): string

Builds the final endpoint URL based on the passed parameters

Parameters​

NameTypeDescription
paramsPartial<P>The params to add to the request

Returns​

string

The endpoint URL.

Inherited from​

AbstractFetchStrategy.buildEndpointURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:220

fetchArchive​

▸ fetchArchive(url, params, options?): Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: R }>

Parameters​

NameType
urlstring
paramsPostsArchiveParams
options?Partial<FetchOptions>

Returns​

Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: R }>

Defined in​

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:145

fetchSingle​

▸ fetchSingle(url, params, options?): Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: R }>

Parameters​

NameType
urlstring
paramsPostParams
options?Partial<FetchOptions>

Returns​

Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: R }>

Defined in​

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:132

fetcher​

▸ fetcher(url, params, options?): Promise<FetchResponse<R>>

The default fetcher function

The default fetcher function handles authentication headers and errors from the API.

A custom strategy can override this function to run additional logic before or after the fetch call

Parameters​

NameTypeDescription
urlstringThe URL to fetch
paramsPartial<P>The request params
options?Partial<FetchOptions>The fetcher options

Returns​

Promise<FetchResponse<R>>

Overrides​

AbstractFetchStrategy.fetcher

Defined in​

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:158

filterData​

▸ filterData(data, filterOptions?): FetchResponse<R>

Filters the data returned from the API by excluding fields that are not needed in order to reduce +payload size.

Parameters​

NameTypeDescription
dataFetchResponse<R>The data to filter
filterOptions?FilterDataOptions<R>Filter options

Returns​

FetchResponse<R>

The filtered data

Inherited from​

AbstractFetchStrategy.filterData

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:377

get​

▸ get(params?): Promise<FetchResponse<R>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage​

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters​

NameTypeDescription
paramsPartial<P>The endpoint params

Returns​

Promise<FetchResponse<R>>

Inherited from​

AbstractFetchStrategy.get

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:442

getAuthHeader​

▸ getAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

AbstractFetchStrategy.getAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:256

getCacheKey​

▸ getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters​

NameTypeDescription
paramsPartial<P>The request params

Returns​

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from​

AbstractFetchStrategy.getCacheKey

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:407

getDefaultEndpoint​

▸ getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint +for the strategy

Returns​

string

Overrides​

AbstractFetchStrategy.getDefaultEndpoint

Defined in​

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:64

getDefaultParams​

▸ getDefaultParams(): Partial<P>

Returns​

Partial<P>

Inherited from​

AbstractFetchStrategy.getDefaultParams

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:182

getEndpoint​

▸ getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, +returns the default endpoint

Returns​

string

The current endpoint for the strategy

Inherited from​

AbstractFetchStrategy.getEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:174

getParamsFromURL​

▸ getParamsFromURL(path, params?): Partial<P>

Returns the supported params from the URL if present.

These params are passed to buildEndpointURL. If the strategy does not support +mapping url params to endpoint params, it should return an empty object.

Parameters​

NameTypeDescription
pathstringThe Path name
paramsPartial<P>The non-url params

Returns​

Partial<P>

params extracted from the URL

Overrides​

AbstractFetchStrategy.getParamsFromURL

Defined in​

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:68

getPreviewAuthHeader​

▸ getPreviewAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

AbstractFetchStrategy.getPreviewAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:247

getPreviewHeaderName​

▸ getPreviewHeaderName(options?): "X-HeadstartWP-Authorization" | "Authorization"

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

"X-HeadstartWP-Authorization" | "Authorization"

Inherited from​

AbstractFetchStrategy.getPreviewHeaderName

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:241

getQueriedObject​

▸ getQueriedObject(response, params): Object

Parameters​

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns​

Object

Inherited from​

AbstractFetchStrategy.getQueriedObject

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:365

isMainQuery​

▸ isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters​

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns​

boolean

Inherited from​

AbstractFetchStrategy.isMainQuery

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:205

normalizeForCache​

▸ normalizeForCache(data, params): NormalizedDataForCache<R, P>

Normalize data for cache.

Parameters​

NameTypeDescription
dataFetchResponse<R>The fetch response data
paramsPartial<P>The request params

Returns​

NormalizedDataForCache<R, P>

Overrides​

AbstractFetchStrategy.normalizeForCache

Defined in​

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:77

prepareResponse​

▸ prepareResponse(response, params): FetchResponse<R>

Parameters​

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns​

FetchResponse<R>

Inherited from​

AbstractFetchStrategy.prepareResponse

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:233

setBaseURL​

▸ setBaseURL(url?): void

Parameters​

NameTypeDefault value
urlundefined | string''

Returns​

void

Inherited from​

AbstractFetchStrategy.setBaseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:164

setEndpoint​

▸ setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters​

NameTypeDescription
endpointstringThe endpoint to fetch

Returns​

void

Inherited from​

AbstractFetchStrategy.setEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/classes/headstartwp_core.PostsArchiveFetchStrategy/index.html b/api/classes/headstartwp_core.PostsArchiveFetchStrategy/index.html index a0f64e6ee..b49b22a06 100644 --- a/api/classes/headstartwp_core.PostsArchiveFetchStrategy/index.html +++ b/api/classes/headstartwp_core.PostsArchiveFetchStrategy/index.html @@ -7,18 +7,18 @@ - - + +
Skip to main content

Class: PostsArchiveFetchStrategy<T, P>

@headstartwp/core.PostsArchiveFetchStrategy

The PostsArchiveFetchStrategy is used to fetch a collection of posts from any post type. -Note that custom post types and custom taxonomies should be defined in headless.config.js

This strategy supports extracting endpoint params from url E.g:

  • /category/cat-name/page/2 maps to { category: 'cat-name', page: 2 }
  • /page/2/ maps to { page: 2 }
  • /genre/genre-name/page/2 maps to { genre: 'genre-name', page: 2 } if a genre taxonomy is defined in headless.config.js

See

getParamsFromURL to learn about url param mapping

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Hierarchy​

Constructors​

constructor​

• new PostsArchiveFetchStrategy<T, P>(baseURL?, defaultParams?)

The strategy constructor

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters​

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from​

AbstractFetchStrategy.constructor

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:143

Properties​

baseURL​

• baseURL: string = ''

The base URL where the API is located

Inherited from​

AbstractFetchStrategy.baseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

defaultParams​

• defaultParams: Partial<P> = {}

The Default Params

Inherited from​

AbstractFetchStrategy.defaultParams

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:119

endpoint​

• endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from​

AbstractFetchStrategy.endpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:124

locale​

• locale: string = ''

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:212

path​

• path: string = ''

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:210

Methods​

buildEndpointURL​

▸ buildEndpointURL(params): string

Handles taxonomy filters and switch endpoint based on post type

Parameters​

NameTypeDescription
paramsPartial<P>The params to build the endpoint with

Returns​

string

Overrides​

AbstractFetchStrategy.buildEndpointURL

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:289

fetcher​

▸ fetcher(url, params, options?): Promise<FetchResponse<T[]>>

Before fetching posts, we need handle taxonomy and authors.

If the headless plugin is not being used, then additional requests needs to be made to get -authors and terms ids

Parameters​

NameTypeDescription
urlstringThe URL to parse
paramsPartial<P>The params to build the endpoint with
optionsPartial<FetchOptions>FetchOptions

Returns​

Promise<FetchResponse<T[]>>

Overrides​

AbstractFetchStrategy.fetcher

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:393

filterData​

▸ filterData(data, options?): FetchResponse<T[]>

Filters the data returned from the API by excluding fields that are not needed in order to reduce -payload size.

Parameters​

NameTypeDescription
dataFetchResponse<T[]>The data to filter
options?FilterDataOptions<T[]>Filter options

Returns​

FetchResponse<T[]>

The filtered data

Overrides​

AbstractFetchStrategy.filterData

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:530

get​

▸ get(params?): Promise<FetchResponse<T[]>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage​

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters​

NameTypeDescription
paramsPartial<P>The endpoint params

Returns​

Promise<FetchResponse<T[]>>

Inherited from​

AbstractFetchStrategy.get

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:442

getAuthHeader​

▸ getAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

AbstractFetchStrategy.getAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:256

getCacheKey​

▸ getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters​

NameTypeDescription
paramsPartial<P>The request params

Returns​

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from​

AbstractFetchStrategy.getCacheKey

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:407

getDefaultEndpoint​

▸ getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint -for the strategy

Returns​

string

Overrides​

AbstractFetchStrategy.getDefaultEndpoint

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:214

getDefaultParams​

▸ getDefaultParams(): Partial<P>

Returns​

Partial<P>

Overrides​

AbstractFetchStrategy.getDefaultParams

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:218

getEndpoint​

▸ getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, -returns the default endpoint

Returns​

string

The current endpoint for the strategy

Inherited from​

AbstractFetchStrategy.getEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:174

getParamsFromURL​

▸ getParamsFromURL(path, params?): Partial<P>

This strategy automatically extracts taxonomy filters, date filters and pagination params from the URL

It also takes into account the custom taxonomies specified in headless.config.js

Parameters​

NameTypeDescription
pathstringThe URL path to extract params from
paramsPartial<P>

Returns​

Partial<P>

Overrides​

AbstractFetchStrategy.getParamsFromURL

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:230

getPreviewAuthHeader​

▸ getPreviewAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

AbstractFetchStrategy.getPreviewAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:247

getPreviewHeaderName​

▸ getPreviewHeaderName(options?): "X-HeadstartWP-Authorization" | "Authorization"

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

"X-HeadstartWP-Authorization" | "Authorization"

Inherited from​

AbstractFetchStrategy.getPreviewHeaderName

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:241

getQueriedObject​

▸ getQueriedObject(response, params): QueriedObject

Returns the queried object if applicable (e.g if querying by category, tag, author or custom taxonomy term)

Parameters​

NameTypeDescription
responseFetchResponse<T[]>The response from the API
paramsPartial<P>The request params

Returns​

QueriedObject

Overrides​

AbstractFetchStrategy.getQueriedObject

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:461

isMainQuery​

▸ isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters​

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns​

boolean

Inherited from​

AbstractFetchStrategy.isMainQuery

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:205

normalizeForCache​

▸ normalizeForCache(data, params): NormalizedDataForCache<T[], P>

Normalize data for cache.

Parameters​

NameTypeDescription
dataFetchResponse<T[]>The fetch response data
paramsPartial<P>The request params

Returns​

NormalizedDataForCache<T[], P>

Inherited from​

AbstractFetchStrategy.normalizeForCache

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:417

prepareResponse​

▸ prepareResponse(response, params): FetchResponse<T[]>

Parameters​

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns​

FetchResponse<T[]>

Overrides​

AbstractFetchStrategy.prepareResponse

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:327

setBaseURL​

▸ setBaseURL(url?): void

Parameters​

NameTypeDefault value
urlundefined | string''

Returns​

void

Inherited from​

AbstractFetchStrategy.setBaseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:164

setEndpoint​

▸ setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters​

NameTypeDescription
endpointstringThe endpoint to fetch

Returns​

void

Inherited from​

AbstractFetchStrategy.setEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +Note that custom post types and custom taxonomies should be defined in headless.config.js

This strategy supports extracting endpoint params from url E.g:

See

getParamsFromURL to learn about url param mapping

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Hierarchy​

Constructors​

constructor​

• new PostsArchiveFetchStrategy<T, P>(baseURL?, defaultParams?)

The strategy constructor

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters​

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from​

AbstractFetchStrategy.constructor

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:143

Properties​

baseURL​

• baseURL: string = ''

The base URL where the API is located

Inherited from​

AbstractFetchStrategy.baseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

defaultParams​

• defaultParams: Partial<P> = {}

The Default Params

Inherited from​

AbstractFetchStrategy.defaultParams

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:119

endpoint​

• endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from​

AbstractFetchStrategy.endpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:124

locale​

• locale: string = ''

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:212

path​

• path: string = ''

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:210

Methods​

buildEndpointURL​

▸ buildEndpointURL(params): string

Handles taxonomy filters and switch endpoint based on post type

Parameters​

NameTypeDescription
paramsPartial<P>The params to build the endpoint with

Returns​

string

Overrides​

AbstractFetchStrategy.buildEndpointURL

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:289

fetcher​

▸ fetcher(url, params, options?): Promise<FetchResponse<T[]>>

Before fetching posts, we need handle taxonomy and authors.

If the headless plugin is not being used, then additional requests needs to be made to get +authors and terms ids

Parameters​

NameTypeDescription
urlstringThe URL to parse
paramsPartial<P>The params to build the endpoint with
optionsPartial<FetchOptions>FetchOptions

Returns​

Promise<FetchResponse<T[]>>

Overrides​

AbstractFetchStrategy.fetcher

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:393

filterData​

▸ filterData(data, options?): FetchResponse<T[]>

Filters the data returned from the API by excluding fields that are not needed in order to reduce +payload size.

Parameters​

NameTypeDescription
dataFetchResponse<T[]>The data to filter
options?FilterDataOptions<T[]>Filter options

Returns​

FetchResponse<T[]>

The filtered data

Overrides​

AbstractFetchStrategy.filterData

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:530

get​

▸ get(params?): Promise<FetchResponse<T[]>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage​

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters​

NameTypeDescription
paramsPartial<P>The endpoint params

Returns​

Promise<FetchResponse<T[]>>

Inherited from​

AbstractFetchStrategy.get

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:442

getAuthHeader​

▸ getAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

AbstractFetchStrategy.getAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:256

getCacheKey​

▸ getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters​

NameTypeDescription
paramsPartial<P>The request params

Returns​

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from​

AbstractFetchStrategy.getCacheKey

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:407

getDefaultEndpoint​

▸ getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint +for the strategy

Returns​

string

Overrides​

AbstractFetchStrategy.getDefaultEndpoint

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:214

getDefaultParams​

▸ getDefaultParams(): Partial<P>

Returns​

Partial<P>

Overrides​

AbstractFetchStrategy.getDefaultParams

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:218

getEndpoint​

▸ getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, +returns the default endpoint

Returns​

string

The current endpoint for the strategy

Inherited from​

AbstractFetchStrategy.getEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:174

getParamsFromURL​

▸ getParamsFromURL(path, params?): Partial<P>

This strategy automatically extracts taxonomy filters, date filters and pagination params from the URL

It also takes into account the custom taxonomies specified in headless.config.js

Parameters​

NameTypeDescription
pathstringThe URL path to extract params from
paramsPartial<P>

Returns​

Partial<P>

Overrides​

AbstractFetchStrategy.getParamsFromURL

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:230

getPreviewAuthHeader​

▸ getPreviewAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

AbstractFetchStrategy.getPreviewAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:247

getPreviewHeaderName​

▸ getPreviewHeaderName(options?): "X-HeadstartWP-Authorization" | "Authorization"

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

"X-HeadstartWP-Authorization" | "Authorization"

Inherited from​

AbstractFetchStrategy.getPreviewHeaderName

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:241

getQueriedObject​

▸ getQueriedObject(response, params): QueriedObject

Returns the queried object if applicable (e.g if querying by category, tag, author or custom taxonomy term)

Parameters​

NameTypeDescription
responseFetchResponse<T[]>The response from the API
paramsPartial<P>The request params

Returns​

QueriedObject

Overrides​

AbstractFetchStrategy.getQueriedObject

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:461

isMainQuery​

▸ isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters​

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns​

boolean

Inherited from​

AbstractFetchStrategy.isMainQuery

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:205

normalizeForCache​

▸ normalizeForCache(data, params): NormalizedDataForCache<T[], P>

Normalize data for cache.

Parameters​

NameTypeDescription
dataFetchResponse<T[]>The fetch response data
paramsPartial<P>The request params

Returns​

NormalizedDataForCache<T[], P>

Inherited from​

AbstractFetchStrategy.normalizeForCache

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:417

prepareResponse​

▸ prepareResponse(response, params): FetchResponse<T[]>

Parameters​

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns​

FetchResponse<T[]>

Overrides​

AbstractFetchStrategy.prepareResponse

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:327

setBaseURL​

▸ setBaseURL(url?): void

Parameters​

NameTypeDefault value
urlundefined | string''

Returns​

void

Inherited from​

AbstractFetchStrategy.setBaseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:164

setEndpoint​

▸ setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters​

NameTypeDescription
endpointstringThe endpoint to fetch

Returns​

void

Inherited from​

AbstractFetchStrategy.setEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/classes/headstartwp_core.ProcessingInstruction/index.html b/api/classes/headstartwp_core.ProcessingInstruction/index.html index ad0307f00..31f452f52 100644 --- a/api/classes/headstartwp_core.ProcessingInstruction/index.html +++ b/api/classes/headstartwp_core.ProcessingInstruction/index.html @@ -7,8 +7,8 @@ - - + +
@@ -17,7 +17,7 @@ DOM spec-compatible alias.

Returns​

string

Inherited from​

DataNode.nodeValue

Defined in​

node_modules/domhandler/lib/node.d.ts:90

• set nodeValue(data): void

Parameters​

NameType
datastring

Returns​

void

Inherited from​

DataNode.nodeValue

Defined in​

node_modules/domhandler/lib/node.d.ts:91

parentNode​

• get parentNode(): null | ParentNode

Same as parent. DOM spec-compatible alias.

Returns​

null | ParentNode

Inherited from​

DataNode.parentNode

Defined in​

node_modules/domhandler/lib/node.d.ts:55

• set parentNode(parent): void

Parameters​

NameType
parentnull | ParentNode

Returns​

void

Inherited from​

DataNode.parentNode

Defined in​

node_modules/domhandler/lib/node.d.ts:56

previousSibling​

• get previousSibling(): null | ChildNode

Same as prev. DOM spec-compatible alias.

Returns​

null | ChildNode

Inherited from​

DataNode.previousSibling

Defined in​

node_modules/domhandler/lib/node.d.ts:61

• set previousSibling(prev): void

Parameters​

NameType
prevnull | ChildNode

Returns​

void

Inherited from​

DataNode.previousSibling

Defined in​

node_modules/domhandler/lib/node.d.ts:62

Methods​

cloneNode​

▸ cloneNode<T>(this, recursive?): T

Clone this node, and optionally its children.

Type parameters​

NameType
Textends Node<T>

Parameters​

NameTypeDescription
thisT-
recursive?booleanClone child nodes as well.

Returns​

T

A clone of the node.

Inherited from​

DataNode.cloneNode

Defined in​

node_modules/domhandler/lib/node.d.ts:75

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - + + \ No newline at end of file diff --git a/api/classes/headstartwp_core.SearchFetchStrategy/index.html b/api/classes/headstartwp_core.SearchFetchStrategy/index.html index ae5742c98..0f0ea5e59 100644 --- a/api/classes/headstartwp_core.SearchFetchStrategy/index.html +++ b/api/classes/headstartwp_core.SearchFetchStrategy/index.html @@ -7,18 +7,18 @@ - - + +
Skip to main content

Class: SearchFetchStrategy<T, P>

@headstartwp/core.SearchFetchStrategy

The SearchFetchStrategy extends the PostsArchiveFetchStrategy and does not make use of the -search endpoint. Instead it uses the specified postType endpoint.

This strategy supports extracting endpoint params from url E.g:

  • /page/2/ maps to { page: 2 }
  • /searched-term/page/2 maps to { search: 'searched-term', page: 2 }

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Hierarchy​

Constructors​

constructor​

• new SearchFetchStrategy<T, P>(baseURL?, defaultParams?)

The strategy constructor

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters​

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from​

PostsArchiveFetchStrategy.constructor

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:143

Properties​

baseURL​

• baseURL: string = ''

The base URL where the API is located

Inherited from​

PostsArchiveFetchStrategy.baseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

defaultParams​

• defaultParams: Partial<P> = {}

The Default Params

Inherited from​

PostsArchiveFetchStrategy.defaultParams

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:119

endpoint​

• endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from​

PostsArchiveFetchStrategy.endpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:124

locale​

• locale: string = ''

Inherited from​

PostsArchiveFetchStrategy.locale

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:212

path​

• path: string = ''

Inherited from​

PostsArchiveFetchStrategy.path

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:210

Methods​

buildEndpointURL​

▸ buildEndpointURL(params): string

Handles taxonomy filters and switch endpoint based on post type

Parameters​

NameTypeDescription
paramsPartial<P>The params to build the endpoint with

Returns​

string

Inherited from​

PostsArchiveFetchStrategy.buildEndpointURL

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:289

fetcher​

▸ fetcher(url, params, options?): Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: T[] }>

The fetcher function is overridden to disable throwing if not found

If a search request returns not found we do not want to redirect to a 404 page, -instead the user should be informed that no posts were found

Parameters​

NameTypeDescription
urlstringThe url to parse
paramsPartial<P>The params to build the endpoint with
optionsPartial<FetchOptions>FetchOptions

Returns​

Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: T[] }>

Overrides​

PostsArchiveFetchStrategy.fetcher

Defined in​

packages/core/src/data/strategies/SearchFetchStrategy.ts:46

filterData​

▸ filterData(data, options?): FetchResponse<T[]>

Filters the data returned from the API by excluding fields that are not needed in order to reduce -payload size.

Parameters​

NameTypeDescription
dataFetchResponse<T[]>The data to filter
options?FilterDataOptions<T[]>Filter options

Returns​

FetchResponse<T[]>

The filtered data

Inherited from​

PostsArchiveFetchStrategy.filterData

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:530

get​

▸ get(params?): Promise<FetchResponse<T[]>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage​

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters​

NameTypeDescription
paramsPartial<P>The endpoint params

Returns​

Promise<FetchResponse<T[]>>

Inherited from​

PostsArchiveFetchStrategy.get

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:442

getAuthHeader​

▸ getAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

PostsArchiveFetchStrategy.getAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:256

getCacheKey​

▸ getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters​

NameTypeDescription
paramsPartial<P>The request params

Returns​

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from​

PostsArchiveFetchStrategy.getCacheKey

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:407

getDefaultEndpoint​

▸ getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint -for the strategy

Returns​

string

Overrides​

PostsArchiveFetchStrategy.getDefaultEndpoint

Defined in​

packages/core/src/data/strategies/SearchFetchStrategy.ts:24

getDefaultParams​

▸ getDefaultParams(): Partial<P>

Returns​

Partial<P>

Inherited from​

PostsArchiveFetchStrategy.getDefaultParams

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:218

getEndpoint​

▸ getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, -returns the default endpoint

Returns​

string

The current endpoint for the strategy

Inherited from​

PostsArchiveFetchStrategy.getEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:174

getParamsFromURL​

▸ getParamsFromURL(path, nonUrlParams?): Partial<P>

This strategy automatically extracts taxonomy filters, date filters and pagination params from the URL

It also takes into account the custom taxonomies specified in headless.config.js

Parameters​

NameTypeDescription
pathstringThe URL path to extract params from
nonUrlParamsPartial<P>

Returns​

Partial<P>

Overrides​

PostsArchiveFetchStrategy.getParamsFromURL

Defined in​

packages/core/src/data/strategies/SearchFetchStrategy.ts:28

getPreviewAuthHeader​

▸ getPreviewAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

PostsArchiveFetchStrategy.getPreviewAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:247

getPreviewHeaderName​

▸ getPreviewHeaderName(options?): "X-HeadstartWP-Authorization" | "Authorization"

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

"X-HeadstartWP-Authorization" | "Authorization"

Inherited from​

PostsArchiveFetchStrategy.getPreviewHeaderName

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:241

getQueriedObject​

▸ getQueriedObject(response, params): QueriedObject

Returns the queried object if applicable (e.g if querying by category, tag, author or custom taxonomy term)

Parameters​

NameTypeDescription
responseFetchResponse<T[]>The response from the API
paramsPartial<P>The request params

Returns​

QueriedObject

Inherited from​

PostsArchiveFetchStrategy.getQueriedObject

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:461

isMainQuery​

▸ isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters​

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns​

boolean

Inherited from​

PostsArchiveFetchStrategy.isMainQuery

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:205

normalizeForCache​

▸ normalizeForCache(data, params): NormalizedDataForCache<T[], P>

Normalize data for cache.

Parameters​

NameTypeDescription
dataFetchResponse<T[]>The fetch response data
paramsPartial<P>The request params

Returns​

NormalizedDataForCache<T[], P>

Inherited from​

PostsArchiveFetchStrategy.normalizeForCache

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:417

prepareResponse​

▸ prepareResponse(response, params): FetchResponse<T[]>

Parameters​

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns​

FetchResponse<T[]>

Inherited from​

PostsArchiveFetchStrategy.prepareResponse

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:327

setBaseURL​

▸ setBaseURL(url?): void

Parameters​

NameTypeDefault value
urlundefined | string''

Returns​

void

Inherited from​

PostsArchiveFetchStrategy.setBaseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:164

setEndpoint​

▸ setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters​

NameTypeDescription
endpointstringThe endpoint to fetch

Returns​

void

Inherited from​

PostsArchiveFetchStrategy.setEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +search endpoint. Instead it uses the specified postType endpoint.

This strategy supports extracting endpoint params from url E.g:

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Hierarchy​

Constructors​

constructor​

• new SearchFetchStrategy<T, P>(baseURL?, defaultParams?)

The strategy constructor

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters​

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from​

PostsArchiveFetchStrategy.constructor

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:143

Properties​

baseURL​

• baseURL: string = ''

The base URL where the API is located

Inherited from​

PostsArchiveFetchStrategy.baseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

defaultParams​

• defaultParams: Partial<P> = {}

The Default Params

Inherited from​

PostsArchiveFetchStrategy.defaultParams

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:119

endpoint​

• endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from​

PostsArchiveFetchStrategy.endpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:124

locale​

• locale: string = ''

Inherited from​

PostsArchiveFetchStrategy.locale

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:212

path​

• path: string = ''

Inherited from​

PostsArchiveFetchStrategy.path

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:210

Methods​

buildEndpointURL​

▸ buildEndpointURL(params): string

Handles taxonomy filters and switch endpoint based on post type

Parameters​

NameTypeDescription
paramsPartial<P>The params to build the endpoint with

Returns​

string

Inherited from​

PostsArchiveFetchStrategy.buildEndpointURL

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:289

fetcher​

▸ fetcher(url, params, options?): Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: T[] }>

The fetcher function is overridden to disable throwing if not found

If a search request returns not found we do not want to redirect to a 404 page, +instead the user should be informed that no posts were found

Parameters​

NameTypeDescription
urlstringThe url to parse
paramsPartial<P>The params to build the endpoint with
optionsPartial<FetchOptions>FetchOptions

Returns​

Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: T[] }>

Overrides​

PostsArchiveFetchStrategy.fetcher

Defined in​

packages/core/src/data/strategies/SearchFetchStrategy.ts:46

filterData​

▸ filterData(data, options?): FetchResponse<T[]>

Filters the data returned from the API by excluding fields that are not needed in order to reduce +payload size.

Parameters​

NameTypeDescription
dataFetchResponse<T[]>The data to filter
options?FilterDataOptions<T[]>Filter options

Returns​

FetchResponse<T[]>

The filtered data

Inherited from​

PostsArchiveFetchStrategy.filterData

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:530

get​

▸ get(params?): Promise<FetchResponse<T[]>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage​

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters​

NameTypeDescription
paramsPartial<P>The endpoint params

Returns​

Promise<FetchResponse<T[]>>

Inherited from​

PostsArchiveFetchStrategy.get

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:442

getAuthHeader​

▸ getAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

PostsArchiveFetchStrategy.getAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:256

getCacheKey​

▸ getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters​

NameTypeDescription
paramsPartial<P>The request params

Returns​

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from​

PostsArchiveFetchStrategy.getCacheKey

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:407

getDefaultEndpoint​

▸ getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint +for the strategy

Returns​

string

Overrides​

PostsArchiveFetchStrategy.getDefaultEndpoint

Defined in​

packages/core/src/data/strategies/SearchFetchStrategy.ts:24

getDefaultParams​

▸ getDefaultParams(): Partial<P>

Returns​

Partial<P>

Inherited from​

PostsArchiveFetchStrategy.getDefaultParams

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:218

getEndpoint​

▸ getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, +returns the default endpoint

Returns​

string

The current endpoint for the strategy

Inherited from​

PostsArchiveFetchStrategy.getEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:174

getParamsFromURL​

▸ getParamsFromURL(path, nonUrlParams?): Partial<P>

This strategy automatically extracts taxonomy filters, date filters and pagination params from the URL

It also takes into account the custom taxonomies specified in headless.config.js

Parameters​

NameTypeDescription
pathstringThe URL path to extract params from
nonUrlParamsPartial<P>

Returns​

Partial<P>

Overrides​

PostsArchiveFetchStrategy.getParamsFromURL

Defined in​

packages/core/src/data/strategies/SearchFetchStrategy.ts:28

getPreviewAuthHeader​

▸ getPreviewAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

PostsArchiveFetchStrategy.getPreviewAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:247

getPreviewHeaderName​

▸ getPreviewHeaderName(options?): "X-HeadstartWP-Authorization" | "Authorization"

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

"X-HeadstartWP-Authorization" | "Authorization"

Inherited from​

PostsArchiveFetchStrategy.getPreviewHeaderName

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:241

getQueriedObject​

▸ getQueriedObject(response, params): QueriedObject

Returns the queried object if applicable (e.g if querying by category, tag, author or custom taxonomy term)

Parameters​

NameTypeDescription
responseFetchResponse<T[]>The response from the API
paramsPartial<P>The request params

Returns​

QueriedObject

Inherited from​

PostsArchiveFetchStrategy.getQueriedObject

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:461

isMainQuery​

▸ isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters​

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns​

boolean

Inherited from​

PostsArchiveFetchStrategy.isMainQuery

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:205

normalizeForCache​

▸ normalizeForCache(data, params): NormalizedDataForCache<T[], P>

Normalize data for cache.

Parameters​

NameTypeDescription
dataFetchResponse<T[]>The fetch response data
paramsPartial<P>The request params

Returns​

NormalizedDataForCache<T[], P>

Inherited from​

PostsArchiveFetchStrategy.normalizeForCache

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:417

prepareResponse​

▸ prepareResponse(response, params): FetchResponse<T[]>

Parameters​

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns​

FetchResponse<T[]>

Inherited from​

PostsArchiveFetchStrategy.prepareResponse

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:327

setBaseURL​

▸ setBaseURL(url?): void

Parameters​

NameTypeDefault value
urlundefined | string''

Returns​

void

Inherited from​

PostsArchiveFetchStrategy.setBaseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:164

setEndpoint​

▸ setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters​

NameTypeDescription
endpointstringThe endpoint to fetch

Returns​

void

Inherited from​

PostsArchiveFetchStrategy.setEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/classes/headstartwp_core.SearchNativeFetchStrategy/index.html b/api/classes/headstartwp_core.SearchNativeFetchStrategy/index.html index cdbcec1fe..5b99e1498 100644 --- a/api/classes/headstartwp_core.SearchNativeFetchStrategy/index.html +++ b/api/classes/headstartwp_core.SearchNativeFetchStrategy/index.html @@ -7,18 +7,18 @@ - - + +
Skip to main content

Class: SearchNativeFetchStrategy<T, P>

@headstartwp/core.SearchNativeFetchStrategy

The SearchNativeFetchStrategy is used to fetch search results for a given search query -Uses the native WordPress search endpoint.

Note that custom post types and custom taxonomies should be defined in headless.config.js

This strategy supports extracting endpoint params from url E.g:

  • /page/2/ maps to { page: 2 }
  • /searched-term/page/2 maps to { search: 'searched-term', page: 2 }

See

getParamsFromURL to learn about url param mapping

Type parameters​

NameType
Textends PostSearchEntity | TermSearchEntity = PostSearchEntity | TermSearchEntity
Pextends SearchParams = SearchParams

Hierarchy​

Constructors​

constructor​

• new SearchNativeFetchStrategy<T, P>(baseURL?, defaultParams?)

The strategy constructor

Type parameters​

NameType
Textends PostSearchEntity | TermSearchEntity = PostSearchEntity | TermSearchEntity
Pextends SearchParams = SearchParams

Parameters​

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from​

AbstractFetchStrategy.constructor

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:143

Properties​

baseURL​

• baseURL: string = ''

The base URL where the API is located

Inherited from​

AbstractFetchStrategy.baseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

defaultParams​

• defaultParams: Partial<P> = {}

The Default Params

Inherited from​

AbstractFetchStrategy.defaultParams

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:119

endpoint​

• endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from​

AbstractFetchStrategy.endpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:124

locale​

• locale: string = ''

Defined in​

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:75

path​

• path: string = ''

Defined in​

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:73

Methods​

buildEndpointURL​

▸ buildEndpointURL(params): string

Builds the endpoint url for the search endpoint

Parameters​

NameTypeDescription
paramsPartial<P>The params for the request

Returns​

string

Overrides​

AbstractFetchStrategy.buildEndpointURL

Defined in​

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:106

fetcher​

▸ fetcher(url, params, options?): Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: T[] }>

The fetcher function is overridden to disable throwing if not found

If a search request returns not found we do not want to redirect to a 404 page, -instead the user should be informed that no posts were found

Parameters​

NameTypeDescription
urlstringThe url to parse
paramsPartial<P>The params to build the endpoint with
optionsPartial<FetchOptions>FetchOptions

Returns​

Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: T[] }>

Overrides​

AbstractFetchStrategy.fetcher

Defined in​

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:125

filterData​

▸ filterData(data, filterOptions?): FetchResponse<T[]>

Filters the data returned from the API by excluding fields that are not needed in order to reduce -payload size.

Parameters​

NameTypeDescription
dataFetchResponse<T[]>The data to filter
filterOptions?FilterDataOptions<T[]>Filter options

Returns​

FetchResponse<T[]>

The filtered data

Inherited from​

AbstractFetchStrategy.filterData

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:377

get​

▸ get(params?): Promise<FetchResponse<T[]>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage​

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters​

NameTypeDescription
paramsPartial<P>The endpoint params

Returns​

Promise<FetchResponse<T[]>>

Inherited from​

AbstractFetchStrategy.get

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:442

getAuthHeader​

▸ getAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

AbstractFetchStrategy.getAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:256

getCacheKey​

▸ getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters​

NameTypeDescription
paramsPartial<P>The request params

Returns​

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from​

AbstractFetchStrategy.getCacheKey

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:407

getDefaultEndpoint​

▸ getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint -for the strategy

Returns​

string

Overrides​

AbstractFetchStrategy.getDefaultEndpoint

Defined in​

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:77

getDefaultParams​

▸ getDefaultParams(): Partial<P>

Returns​

Partial<P>

Overrides​

AbstractFetchStrategy.getDefaultParams

Defined in​

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:81

getEndpoint​

▸ getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, -returns the default endpoint

Returns​

string

The current endpoint for the strategy

Inherited from​

AbstractFetchStrategy.getEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:174

getParamsFromURL​

▸ getParamsFromURL(path, params?): Partial<P>

This strategy automatically extracts the search term and and pagination params from the URL

Parameters​

NameTypeDescription
pathstringThe URL path to extract params from
paramsPartial<P>The params passed to the strategy

Returns​

Partial<P>

Overrides​

AbstractFetchStrategy.getParamsFromURL

Defined in​

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:91

getPreviewAuthHeader​

▸ getPreviewAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

AbstractFetchStrategy.getPreviewAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:247

getPreviewHeaderName​

▸ getPreviewHeaderName(options?): "X-HeadstartWP-Authorization" | "Authorization"

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

"X-HeadstartWP-Authorization" | "Authorization"

Inherited from​

AbstractFetchStrategy.getPreviewHeaderName

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:241

getQueriedObject​

▸ getQueriedObject(response, params): Object

Parameters​

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns​

Object

Inherited from​

AbstractFetchStrategy.getQueriedObject

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:365

isMainQuery​

▸ isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters​

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns​

boolean

Inherited from​

AbstractFetchStrategy.isMainQuery

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:205

normalizeForCache​

▸ normalizeForCache(data, params): NormalizedDataForCache<T[], P>

Normalize data for cache.

Parameters​

NameTypeDescription
dataFetchResponse<T[]>The fetch response data
paramsPartial<P>The request params

Returns​

NormalizedDataForCache<T[], P>

Inherited from​

AbstractFetchStrategy.normalizeForCache

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:417

prepareResponse​

▸ prepareResponse(response, params): FetchResponse<T[]>

Parameters​

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns​

FetchResponse<T[]>

Inherited from​

AbstractFetchStrategy.prepareResponse

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:233

setBaseURL​

▸ setBaseURL(url?): void

Parameters​

NameTypeDefault value
urlundefined | string''

Returns​

void

Inherited from​

AbstractFetchStrategy.setBaseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:164

setEndpoint​

▸ setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters​

NameTypeDescription
endpointstringThe endpoint to fetch

Returns​

void

Inherited from​

AbstractFetchStrategy.setEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +Uses the native WordPress search endpoint.

Note that custom post types and custom taxonomies should be defined in headless.config.js

This strategy supports extracting endpoint params from url E.g:

See

getParamsFromURL to learn about url param mapping

Type parameters​

NameType
Textends PostSearchEntity | TermSearchEntity = PostSearchEntity | TermSearchEntity
Pextends SearchParams = SearchParams

Hierarchy​

Constructors​

constructor​

• new SearchNativeFetchStrategy<T, P>(baseURL?, defaultParams?)

The strategy constructor

Type parameters​

NameType
Textends PostSearchEntity | TermSearchEntity = PostSearchEntity | TermSearchEntity
Pextends SearchParams = SearchParams

Parameters​

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from​

AbstractFetchStrategy.constructor

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:143

Properties​

baseURL​

• baseURL: string = ''

The base URL where the API is located

Inherited from​

AbstractFetchStrategy.baseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

defaultParams​

• defaultParams: Partial<P> = {}

The Default Params

Inherited from​

AbstractFetchStrategy.defaultParams

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:119

endpoint​

• endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from​

AbstractFetchStrategy.endpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:124

locale​

• locale: string = ''

Defined in​

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:75

path​

• path: string = ''

Defined in​

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:73

Methods​

buildEndpointURL​

▸ buildEndpointURL(params): string

Builds the endpoint url for the search endpoint

Parameters​

NameTypeDescription
paramsPartial<P>The params for the request

Returns​

string

Overrides​

AbstractFetchStrategy.buildEndpointURL

Defined in​

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:106

fetcher​

▸ fetcher(url, params, options?): Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: T[] }>

The fetcher function is overridden to disable throwing if not found

If a search request returns not found we do not want to redirect to a 404 page, +instead the user should be informed that no posts were found

Parameters​

NameTypeDescription
urlstringThe url to parse
paramsPartial<P>The params to build the endpoint with
optionsPartial<FetchOptions>FetchOptions

Returns​

Promise<{ pageInfo: PageInfo ; queriedObject: QueriedObject ; result: T[] }>

Overrides​

AbstractFetchStrategy.fetcher

Defined in​

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:125

filterData​

▸ filterData(data, filterOptions?): FetchResponse<T[]>

Filters the data returned from the API by excluding fields that are not needed in order to reduce +payload size.

Parameters​

NameTypeDescription
dataFetchResponse<T[]>The data to filter
filterOptions?FilterDataOptions<T[]>Filter options

Returns​

FetchResponse<T[]>

The filtered data

Inherited from​

AbstractFetchStrategy.filterData

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:377

get​

▸ get(params?): Promise<FetchResponse<T[]>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage​

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters​

NameTypeDescription
paramsPartial<P>The endpoint params

Returns​

Promise<FetchResponse<T[]>>

Inherited from​

AbstractFetchStrategy.get

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:442

getAuthHeader​

▸ getAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

AbstractFetchStrategy.getAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:256

getCacheKey​

▸ getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters​

NameTypeDescription
paramsPartial<P>The request params

Returns​

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from​

AbstractFetchStrategy.getCacheKey

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:407

getDefaultEndpoint​

▸ getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint +for the strategy

Returns​

string

Overrides​

AbstractFetchStrategy.getDefaultEndpoint

Defined in​

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:77

getDefaultParams​

▸ getDefaultParams(): Partial<P>

Returns​

Partial<P>

Overrides​

AbstractFetchStrategy.getDefaultParams

Defined in​

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:81

getEndpoint​

▸ getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, +returns the default endpoint

Returns​

string

The current endpoint for the strategy

Inherited from​

AbstractFetchStrategy.getEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:174

getParamsFromURL​

▸ getParamsFromURL(path, params?): Partial<P>

This strategy automatically extracts the search term and and pagination params from the URL

Parameters​

NameTypeDescription
pathstringThe URL path to extract params from
paramsPartial<P>The params passed to the strategy

Returns​

Partial<P>

Overrides​

AbstractFetchStrategy.getParamsFromURL

Defined in​

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:91

getPreviewAuthHeader​

▸ getPreviewAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

AbstractFetchStrategy.getPreviewAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:247

getPreviewHeaderName​

▸ getPreviewHeaderName(options?): "X-HeadstartWP-Authorization" | "Authorization"

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

"X-HeadstartWP-Authorization" | "Authorization"

Inherited from​

AbstractFetchStrategy.getPreviewHeaderName

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:241

getQueriedObject​

▸ getQueriedObject(response, params): Object

Parameters​

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns​

Object

Inherited from​

AbstractFetchStrategy.getQueriedObject

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:365

isMainQuery​

▸ isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters​

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns​

boolean

Inherited from​

AbstractFetchStrategy.isMainQuery

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:205

normalizeForCache​

▸ normalizeForCache(data, params): NormalizedDataForCache<T[], P>

Normalize data for cache.

Parameters​

NameTypeDescription
dataFetchResponse<T[]>The fetch response data
paramsPartial<P>The request params

Returns​

NormalizedDataForCache<T[], P>

Inherited from​

AbstractFetchStrategy.normalizeForCache

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:417

prepareResponse​

▸ prepareResponse(response, params): FetchResponse<T[]>

Parameters​

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns​

FetchResponse<T[]>

Inherited from​

AbstractFetchStrategy.prepareResponse

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:233

setBaseURL​

▸ setBaseURL(url?): void

Parameters​

NameTypeDefault value
urlundefined | string''

Returns​

void

Inherited from​

AbstractFetchStrategy.setBaseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:164

setEndpoint​

▸ setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters​

NameTypeDescription
endpointstringThe endpoint to fetch

Returns​

void

Inherited from​

AbstractFetchStrategy.setEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/classes/headstartwp_core.SinglePostFetchStrategy/index.html b/api/classes/headstartwp_core.SinglePostFetchStrategy/index.html index 54e4fbd4c..5c733883e 100644 --- a/api/classes/headstartwp_core.SinglePostFetchStrategy/index.html +++ b/api/classes/headstartwp_core.SinglePostFetchStrategy/index.html @@ -7,18 +7,18 @@ - - + +
Skip to main content

Class: SinglePostFetchStrategy<T, P>

@headstartwp/core.SinglePostFetchStrategy

The SinglePostFetchStrategy is used to fetch a single post entity from any post type. -Note that custom post types should be defined in headless.config.js

This strategy supports extracting endpoint params from url E.g:

  • /post-name maps to { slug: 'post-name'}
  • /2021/10/20/post-name maps to { year: 2021, month: 10, day: 20, slug: 'post-name }
  • /2021/ maps to { year: 2021, slug: 'post-name' }

See

getParamsFromURL to learn about url param mapping

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostParams = PostParams

Hierarchy​

Constructors​

constructor​

• new SinglePostFetchStrategy<T, P>(baseURL?, defaultParams?)

The strategy constructor

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostParams = PostParams

Parameters​

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from​

AbstractFetchStrategy.constructor

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:143

Properties​

baseURL​

• baseURL: string = ''

The base URL where the API is located

Inherited from​

AbstractFetchStrategy.baseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

defaultParams​

• defaultParams: Partial<P> = {}

The Default Params

Inherited from​

AbstractFetchStrategy.defaultParams

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:119

endpoint​

• endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from​

AbstractFetchStrategy.endpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:124

locale​

• locale: string = ''

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:89

path​

• path: string = ''

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:87

postType​

• postType: string = 'post'

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:83

revision​

• Optional revision: PostEntity

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:85

• shouldCheckCurrentPathAgainstPostLink: boolean = true

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:91

Methods​

buildEndpointURL​

▸ buildEndpointURL(params): string

Handlers post types, revisions and fetching by id

Parameters​

NameTypeDescription
paramsPThe params to build the endpoint url

Returns​

string

Overrides​

AbstractFetchStrategy.buildEndpointURL

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:127

fetcher​

▸ fetcher(url, params, options?): Promise<FetchResponse<T>>

Handles fetching by multiple post types, authToken and revisions

Parameters​

NameTypeDescription
urlstringThe url to fetch
paramsPThe params to build the endpoint url
optionsPartial<FetchOptions>FetchOptions

Returns​

Promise<FetchResponse<T>>

Overrides​

AbstractFetchStrategy.fetcher

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:275

filterData​

▸ filterData(data, filterOptions?): any

Filters the data returned from the API by excluding fields that are not needed in order to reduce -payload size.

Parameters​

NameTypeDescription
dataFetchResponse<PostEntity>The data to filter
filterOptions?FilterDataOptions<PostEntity>Filter options

Returns​

any

The filtered data

Overrides​

AbstractFetchStrategy.filterData

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:338

get​

▸ get(params?): Promise<FetchResponse<T>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage​

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters​

NameTypeDescription
paramsPartial<P>The endpoint params

Returns​

Promise<FetchResponse<T>>

Inherited from​

AbstractFetchStrategy.get

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:442

getAuthHeader​

▸ getAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

AbstractFetchStrategy.getAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:256

getCacheKey​

▸ getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters​

NameTypeDescription
paramsPartial<P>The request params

Returns​

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from​

AbstractFetchStrategy.getCacheKey

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:407

getDefaultEndpoint​

▸ getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint -for the strategy

Returns​

string

Overrides​

AbstractFetchStrategy.getDefaultEndpoint

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:93

getDefaultParams​

▸ getDefaultParams(): Partial<P>

Returns​

Partial<P>

Overrides​

AbstractFetchStrategy.getDefaultParams

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:97

getEndpoint​

▸ getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, -returns the default endpoint

Returns​

string

The current endpoint for the strategy

Inherited from​

AbstractFetchStrategy.getEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:174

getParamsFromURL​

▸ getParamsFromURL(path, nonUrlParams?): Partial<P>

Returns the supported params from the URL if present.

These params are passed to buildEndpointURL. If the strategy does not support -mapping url params to endpoint params, it should return an empty object.

Parameters​

NameTypeDescription
pathstringThe Path name
nonUrlParamsPartial<P>The non-url params

Returns​

Partial<P>

params extracted from the URL

Overrides​

AbstractFetchStrategy.getParamsFromURL

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:102

getPostThatMatchesCurrentPath​

▸ getPostThatMatchesCurrentPath(result, params): undefined | T

Returns only the post that matches the current path

Parameters​

NameType
resultT[]
paramsPartial<P>

Returns​

undefined | T

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:166

getPreviewAuthHeader​

▸ getPreviewAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

AbstractFetchStrategy.getPreviewAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:247

getPreviewHeaderName​

▸ getPreviewHeaderName(options?): "X-HeadstartWP-Authorization" | "Authorization"

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

"X-HeadstartWP-Authorization" | "Authorization"

Inherited from​

AbstractFetchStrategy.getPreviewHeaderName

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:241

getQueriedObject​

▸ getQueriedObject(response, params): Object

Parameters​

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns​

Object

Inherited from​

AbstractFetchStrategy.getQueriedObject

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:365

isMainQuery​

▸ isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters​

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns​

boolean

Inherited from​

AbstractFetchStrategy.isMainQuery

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:205

normalizeForCache​

▸ normalizeForCache(data, params): NormalizedDataForCache<T, P>

Normalize data for cache.

Parameters​

NameTypeDescription
dataFetchResponse<T>The fetch response data
paramsPartial<P>The request params

Returns​

NormalizedDataForCache<T, P>

Inherited from​

AbstractFetchStrategy.normalizeForCache

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:417

prepareResponse​

▸ prepareResponse(response, params): FetchResponse<T>

Prepares the post response

Parameters​

NameType
responseFetchResponse<T | T[]>
paramsPartial<P>

Returns​

FetchResponse<T>

Overrides​

AbstractFetchStrategy.prepareResponse

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:205

setBaseURL​

▸ setBaseURL(url?): void

Parameters​

NameTypeDefault value
urlundefined | string''

Returns​

void

Inherited from​

AbstractFetchStrategy.setBaseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:164

setEndpoint​

▸ setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters​

NameTypeDescription
endpointstringThe endpoint to fetch

Returns​

void

Inherited from​

AbstractFetchStrategy.setEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +Note that custom post types should be defined in headless.config.js

This strategy supports extracting endpoint params from url E.g:

See

getParamsFromURL to learn about url param mapping

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostParams = PostParams

Hierarchy​

Constructors​

constructor​

• new SinglePostFetchStrategy<T, P>(baseURL?, defaultParams?)

The strategy constructor

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostParams = PostParams

Parameters​

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from​

AbstractFetchStrategy.constructor

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:143

Properties​

baseURL​

• baseURL: string = ''

The base URL where the API is located

Inherited from​

AbstractFetchStrategy.baseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

defaultParams​

• defaultParams: Partial<P> = {}

The Default Params

Inherited from​

AbstractFetchStrategy.defaultParams

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:119

endpoint​

• endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from​

AbstractFetchStrategy.endpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:124

locale​

• locale: string = ''

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:89

path​

• path: string = ''

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:87

postType​

• postType: string = 'post'

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:83

revision​

• Optional revision: PostEntity

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:85

• shouldCheckCurrentPathAgainstPostLink: boolean = true

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:91

Methods​

buildEndpointURL​

▸ buildEndpointURL(params): string

Handlers post types, revisions and fetching by id

Parameters​

NameTypeDescription
paramsPThe params to build the endpoint url

Returns​

string

Overrides​

AbstractFetchStrategy.buildEndpointURL

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:127

fetcher​

▸ fetcher(url, params, options?): Promise<FetchResponse<T>>

Handles fetching by multiple post types, authToken and revisions

Parameters​

NameTypeDescription
urlstringThe url to fetch
paramsPThe params to build the endpoint url
optionsPartial<FetchOptions>FetchOptions

Returns​

Promise<FetchResponse<T>>

Overrides​

AbstractFetchStrategy.fetcher

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:275

filterData​

▸ filterData(data, filterOptions?): any

Filters the data returned from the API by excluding fields that are not needed in order to reduce +payload size.

Parameters​

NameTypeDescription
dataFetchResponse<PostEntity>The data to filter
filterOptions?FilterDataOptions<PostEntity>Filter options

Returns​

any

The filtered data

Overrides​

AbstractFetchStrategy.filterData

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:338

get​

▸ get(params?): Promise<FetchResponse<T>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage​

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters​

NameTypeDescription
paramsPartial<P>The endpoint params

Returns​

Promise<FetchResponse<T>>

Inherited from​

AbstractFetchStrategy.get

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:442

getAuthHeader​

▸ getAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

AbstractFetchStrategy.getAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:256

getCacheKey​

▸ getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters​

NameTypeDescription
paramsPartial<P>The request params

Returns​

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from​

AbstractFetchStrategy.getCacheKey

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:407

getDefaultEndpoint​

▸ getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint +for the strategy

Returns​

string

Overrides​

AbstractFetchStrategy.getDefaultEndpoint

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:93

getDefaultParams​

▸ getDefaultParams(): Partial<P>

Returns​

Partial<P>

Overrides​

AbstractFetchStrategy.getDefaultParams

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:97

getEndpoint​

▸ getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, +returns the default endpoint

Returns​

string

The current endpoint for the strategy

Inherited from​

AbstractFetchStrategy.getEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:174

getParamsFromURL​

▸ getParamsFromURL(path, nonUrlParams?): Partial<P>

Returns the supported params from the URL if present.

These params are passed to buildEndpointURL. If the strategy does not support +mapping url params to endpoint params, it should return an empty object.

Parameters​

NameTypeDescription
pathstringThe Path name
nonUrlParamsPartial<P>The non-url params

Returns​

Partial<P>

params extracted from the URL

Overrides​

AbstractFetchStrategy.getParamsFromURL

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:102

getPostThatMatchesCurrentPath​

▸ getPostThatMatchesCurrentPath(result, params): undefined | T

Returns only the post that matches the current path

Parameters​

NameType
resultT[]
paramsPartial<P>

Returns​

undefined | T

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:166

getPreviewAuthHeader​

▸ getPreviewAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

AbstractFetchStrategy.getPreviewAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:247

getPreviewHeaderName​

▸ getPreviewHeaderName(options?): "X-HeadstartWP-Authorization" | "Authorization"

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

"X-HeadstartWP-Authorization" | "Authorization"

Inherited from​

AbstractFetchStrategy.getPreviewHeaderName

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:241

getQueriedObject​

▸ getQueriedObject(response, params): Object

Parameters​

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns​

Object

Inherited from​

AbstractFetchStrategy.getQueriedObject

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:365

isMainQuery​

▸ isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters​

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns​

boolean

Inherited from​

AbstractFetchStrategy.isMainQuery

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:205

normalizeForCache​

▸ normalizeForCache(data, params): NormalizedDataForCache<T, P>

Normalize data for cache.

Parameters​

NameTypeDescription
dataFetchResponse<T>The fetch response data
paramsPartial<P>The request params

Returns​

NormalizedDataForCache<T, P>

Inherited from​

AbstractFetchStrategy.normalizeForCache

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:417

prepareResponse​

▸ prepareResponse(response, params): FetchResponse<T>

Prepares the post response

Parameters​

NameType
responseFetchResponse<T | T[]>
paramsPartial<P>

Returns​

FetchResponse<T>

Overrides​

AbstractFetchStrategy.prepareResponse

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:205

setBaseURL​

▸ setBaseURL(url?): void

Parameters​

NameTypeDefault value
urlundefined | string''

Returns​

void

Inherited from​

AbstractFetchStrategy.setBaseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:164

setEndpoint​

▸ setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters​

NameTypeDescription
endpointstringThe endpoint to fetch

Returns​

void

Inherited from​

AbstractFetchStrategy.setEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/classes/headstartwp_core.TaxonomyTermsStrategy/index.html b/api/classes/headstartwp_core.TaxonomyTermsStrategy/index.html index 61064f219..975338d66 100644 --- a/api/classes/headstartwp_core.TaxonomyTermsStrategy/index.html +++ b/api/classes/headstartwp_core.TaxonomyTermsStrategy/index.html @@ -7,17 +7,17 @@ - - + +
-
Skip to main content

Class: TaxonomyTermsStrategy<T, P>

@headstartwp/core.TaxonomyTermsStrategy

This fetch strategy does not support extracting url params from the url

Type parameters​

NameType
Textends TermEntity = TermEntity
Pextends TaxonomyArchiveParams = TaxonomyArchiveParams

Hierarchy​

Constructors​

constructor​

• new TaxonomyTermsStrategy<T, P>(baseURL?, defaultParams?)

The strategy constructor

Type parameters​

NameType
Textends TermEntity = TermEntity
Pextends TaxonomyArchiveParams = TaxonomyArchiveParams

Parameters​

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from​

AbstractFetchStrategy.constructor

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:143

Properties​

baseURL​

• baseURL: string = ''

The base URL where the API is located

Inherited from​

AbstractFetchStrategy.baseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

defaultParams​

• defaultParams: Partial<P> = {}

The Default Params

Inherited from​

AbstractFetchStrategy.defaultParams

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:119

defaultTaxonomy​

• defaultTaxonomy: string = 'category'

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:103

endpoint​

• endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from​

AbstractFetchStrategy.endpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:124

Methods​

buildEndpointURL​

▸ buildEndpointURL(params): string

Builds the final endpoint URL based on the passed parameters

Parameters​

NameTypeDescription
paramsPartial<P>The params to add to the request

Returns​

string

The endpoint URL.

Overrides​

AbstractFetchStrategy.buildEndpointURL

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:122

fetcher​

▸ fetcher(url, params, options?): Promise<FetchResponse<T[]>>

The default fetcher function

The default fetcher function handles authentication headers and errors from the API.

A custom strategy can override this function to run additional logic before or after the fetch call

Parameters​

NameTypeDescription
urlstringThe URL to fetch
paramsPartial<P>The request params
options?Partial<FetchOptions>The fetcher options

Returns​

Promise<FetchResponse<T[]>>

Overrides​

AbstractFetchStrategy.fetcher

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:138

filterData​

▸ filterData(data, filterOptions?): FetchResponse<T[]>

Filters the data returned from the API by excluding fields that are not needed in order to reduce -payload size.

Parameters​

NameTypeDescription
dataFetchResponse<T[]>The data to filter
filterOptions?FilterDataOptions<T[]>Filter options

Returns​

FetchResponse<T[]>

The filtered data

Overrides​

AbstractFetchStrategy.filterData

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:146

get​

▸ get(params?): Promise<FetchResponse<T[]>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage​

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters​

NameTypeDescription
paramsPartial<P>The endpoint params

Returns​

Promise<FetchResponse<T[]>>

Inherited from​

AbstractFetchStrategy.get

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:442

getAuthHeader​

▸ getAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

AbstractFetchStrategy.getAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:256

getCacheKey​

▸ getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters​

NameTypeDescription
paramsPartial<P>The request params

Returns​

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from​

AbstractFetchStrategy.getCacheKey

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:407

getDefaultEndpoint​

▸ getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint -for the strategy

Returns​

string

Overrides​

AbstractFetchStrategy.getDefaultEndpoint

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:105

getDefaultParams​

▸ getDefaultParams(): Partial<P>

Returns​

Partial<P>

Overrides​

AbstractFetchStrategy.getDefaultParams

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:109

getEndpoint​

▸ getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, -returns the default endpoint

Returns​

string

The current endpoint for the strategy

Inherited from​

AbstractFetchStrategy.getEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:174

getParamsFromURL​

▸ getParamsFromURL(path, params?): Partial<P>

Returns the supported params from the URL if present.

These params are passed to buildEndpointURL. If the strategy does not support -mapping url params to endpoint params, it should return an empty object.

Parameters​

NameTypeDescription
pathstringThe Path name
paramsPartial<P>The non-url params

Returns​

Partial<P>

params extracted from the URL

Overrides​

AbstractFetchStrategy.getParamsFromURL

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:113

getPreviewAuthHeader​

▸ getPreviewAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

AbstractFetchStrategy.getPreviewAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:247

getPreviewHeaderName​

▸ getPreviewHeaderName(options?): "X-HeadstartWP-Authorization" | "Authorization"

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

"X-HeadstartWP-Authorization" | "Authorization"

Inherited from​

AbstractFetchStrategy.getPreviewHeaderName

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:241

getQueriedObject​

▸ getQueriedObject(response, params): Object

Parameters​

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns​

Object

Inherited from​

AbstractFetchStrategy.getQueriedObject

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:365

isMainQuery​

▸ isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters​

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns​

boolean

Inherited from​

AbstractFetchStrategy.isMainQuery

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:205

normalizeForCache​

▸ normalizeForCache(data, params): NormalizedDataForCache<T[], P>

Normalize data for cache.

Parameters​

NameTypeDescription
dataFetchResponse<T[]>The fetch response data
paramsPartial<P>The request params

Returns​

NormalizedDataForCache<T[], P>

Inherited from​

AbstractFetchStrategy.normalizeForCache

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:417

prepareResponse​

▸ prepareResponse(response, params): FetchResponse<T[]>

Parameters​

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns​

FetchResponse<T[]>

Inherited from​

AbstractFetchStrategy.prepareResponse

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:233

setBaseURL​

▸ setBaseURL(url?): void

Parameters​

NameTypeDefault value
urlundefined | string''

Returns​

void

Inherited from​

AbstractFetchStrategy.setBaseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:164

setEndpoint​

▸ setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters​

NameTypeDescription
endpointstringThe endpoint to fetch

Returns​

void

Inherited from​

AbstractFetchStrategy.setEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Class: TaxonomyTermsStrategy<T, P>

@headstartwp/core.TaxonomyTermsStrategy

This fetch strategy does not support extracting url params from the url

Type parameters​

NameType
Textends TermEntity = TermEntity
Pextends TaxonomyArchiveParams = TaxonomyArchiveParams

Hierarchy​

Constructors​

constructor​

• new TaxonomyTermsStrategy<T, P>(baseURL?, defaultParams?)

The strategy constructor

Type parameters​

NameType
Textends TermEntity = TermEntity
Pextends TaxonomyArchiveParams = TaxonomyArchiveParams

Parameters​

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<P>(optional) list of default params

Inherited from​

AbstractFetchStrategy.constructor

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:143

Properties​

baseURL​

• baseURL: string = ''

The base URL where the API is located

Inherited from​

AbstractFetchStrategy.baseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

defaultParams​

• defaultParams: Partial<P> = {}

The Default Params

Inherited from​

AbstractFetchStrategy.defaultParams

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:119

defaultTaxonomy​

• defaultTaxonomy: string = 'category'

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:103

endpoint​

• endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from​

AbstractFetchStrategy.endpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:124

Methods​

buildEndpointURL​

▸ buildEndpointURL(params): string

Builds the final endpoint URL based on the passed parameters

Parameters​

NameTypeDescription
paramsPartial<P>The params to add to the request

Returns​

string

The endpoint URL.

Overrides​

AbstractFetchStrategy.buildEndpointURL

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:122

fetcher​

▸ fetcher(url, params, options?): Promise<FetchResponse<T[]>>

The default fetcher function

The default fetcher function handles authentication headers and errors from the API.

A custom strategy can override this function to run additional logic before or after the fetch call

Parameters​

NameTypeDescription
urlstringThe URL to fetch
paramsPartial<P>The request params
options?Partial<FetchOptions>The fetcher options

Returns​

Promise<FetchResponse<T[]>>

Overrides​

AbstractFetchStrategy.fetcher

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:138

filterData​

▸ filterData(data, filterOptions?): FetchResponse<T[]>

Filters the data returned from the API by excluding fields that are not needed in order to reduce +payload size.

Parameters​

NameTypeDescription
dataFetchResponse<T[]>The data to filter
filterOptions?FilterDataOptions<T[]>Filter options

Returns​

FetchResponse<T[]>

The filtered data

Overrides​

AbstractFetchStrategy.filterData

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:146

get​

▸ get(params?): Promise<FetchResponse<T[]>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage​

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters​

NameTypeDescription
paramsPartial<P>The endpoint params

Returns​

Promise<FetchResponse<T[]>>

Inherited from​

AbstractFetchStrategy.get

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:442

getAuthHeader​

▸ getAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

AbstractFetchStrategy.getAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:256

getCacheKey​

▸ getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters​

NameTypeDescription
paramsPartial<P>The request params

Returns​

Object

The cache key object

NameType
argsPartial<P> & { sourceUrl: string }
urlstring

Inherited from​

AbstractFetchStrategy.getCacheKey

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:407

getDefaultEndpoint​

▸ getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint +for the strategy

Returns​

string

Overrides​

AbstractFetchStrategy.getDefaultEndpoint

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:105

getDefaultParams​

▸ getDefaultParams(): Partial<P>

Returns​

Partial<P>

Overrides​

AbstractFetchStrategy.getDefaultParams

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:109

getEndpoint​

▸ getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, +returns the default endpoint

Returns​

string

The current endpoint for the strategy

Inherited from​

AbstractFetchStrategy.getEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:174

getParamsFromURL​

▸ getParamsFromURL(path, params?): Partial<P>

Returns the supported params from the URL if present.

These params are passed to buildEndpointURL. If the strategy does not support +mapping url params to endpoint params, it should return an empty object.

Parameters​

NameTypeDescription
pathstringThe Path name
paramsPartial<P>The non-url params

Returns​

Partial<P>

params extracted from the URL

Overrides​

AbstractFetchStrategy.getParamsFromURL

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:113

getPreviewAuthHeader​

▸ getPreviewAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

AbstractFetchStrategy.getPreviewAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:247

getPreviewHeaderName​

▸ getPreviewHeaderName(options?): "X-HeadstartWP-Authorization" | "Authorization"

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

"X-HeadstartWP-Authorization" | "Authorization"

Inherited from​

AbstractFetchStrategy.getPreviewHeaderName

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:241

getQueriedObject​

▸ getQueriedObject(response, params): Object

Parameters​

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns​

Object

Inherited from​

AbstractFetchStrategy.getQueriedObject

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:365

isMainQuery​

▸ isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters​

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<P>The non-url params

Returns​

boolean

Inherited from​

AbstractFetchStrategy.isMainQuery

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:205

normalizeForCache​

▸ normalizeForCache(data, params): NormalizedDataForCache<T[], P>

Normalize data for cache.

Parameters​

NameTypeDescription
dataFetchResponse<T[]>The fetch response data
paramsPartial<P>The request params

Returns​

NormalizedDataForCache<T[], P>

Inherited from​

AbstractFetchStrategy.normalizeForCache

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:417

prepareResponse​

▸ prepareResponse(response, params): FetchResponse<T[]>

Parameters​

NameType
responseFetchResponse<T[]>
paramsPartial<P>

Returns​

FetchResponse<T[]>

Inherited from​

AbstractFetchStrategy.prepareResponse

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:233

setBaseURL​

▸ setBaseURL(url?): void

Parameters​

NameTypeDefault value
urlundefined | string''

Returns​

void

Inherited from​

AbstractFetchStrategy.setBaseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:164

setEndpoint​

▸ setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters​

NameTypeDescription
endpointstringThe endpoint to fetch

Returns​

void

Inherited from​

AbstractFetchStrategy.setEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/classes/headstartwp_core.Text/index.html b/api/classes/headstartwp_core.Text/index.html index 91ea507c0..d5a1a281c 100644 --- a/api/classes/headstartwp_core.Text/index.html +++ b/api/classes/headstartwp_core.Text/index.html @@ -7,8 +7,8 @@ - - + +
@@ -17,7 +17,7 @@ DOM spec-compatible alias.

Returns​

string

Inherited from​

DataNode.nodeValue

Defined in​

node_modules/domhandler/lib/node.d.ts:90

• set nodeValue(data): void

Parameters​

NameType
datastring

Returns​

void

Inherited from​

DataNode.nodeValue

Defined in​

node_modules/domhandler/lib/node.d.ts:91

parentNode​

• get parentNode(): null | ParentNode

Same as parent. DOM spec-compatible alias.

Returns​

null | ParentNode

Inherited from​

DataNode.parentNode

Defined in​

node_modules/domhandler/lib/node.d.ts:55

• set parentNode(parent): void

Parameters​

NameType
parentnull | ParentNode

Returns​

void

Inherited from​

DataNode.parentNode

Defined in​

node_modules/domhandler/lib/node.d.ts:56

previousSibling​

• get previousSibling(): null | ChildNode

Same as prev. DOM spec-compatible alias.

Returns​

null | ChildNode

Inherited from​

DataNode.previousSibling

Defined in​

node_modules/domhandler/lib/node.d.ts:61

• set previousSibling(prev): void

Parameters​

NameType
prevnull | ChildNode

Returns​

void

Inherited from​

DataNode.previousSibling

Defined in​

node_modules/domhandler/lib/node.d.ts:62

Methods​

cloneNode​

▸ cloneNode<T>(this, recursive?): T

Clone this node, and optionally its children.

Type parameters​

NameType
Textends Node<T>

Parameters​

NameTypeDescription
thisT-
recursive?booleanClone child nodes as well.

Returns​

T

A clone of the node.

Inherited from​

DataNode.cloneNode

Defined in​

node_modules/domhandler/lib/node.d.ts:75

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - + + \ No newline at end of file diff --git a/api/classes/headstartwp_core.VerifyTokenFetchStrategy/index.html b/api/classes/headstartwp_core.VerifyTokenFetchStrategy/index.html index 47d78b1ea..37d001ed4 100644 --- a/api/classes/headstartwp_core.VerifyTokenFetchStrategy/index.html +++ b/api/classes/headstartwp_core.VerifyTokenFetchStrategy/index.html @@ -7,18 +7,18 @@ - - + +
Skip to main content

Class: VerifyTokenFetchStrategy

@headstartwp/core.VerifyTokenFetchStrategy

The Verify Token strategy is used to verify tokens issued by the -headless wp plugin

Hierarchy​

Constructors​

constructor​

• new VerifyTokenFetchStrategy(baseURL?, defaultParams?)

The strategy constructor

Parameters​

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<EndpointParams>(optional) list of default params

Inherited from​

AbstractFetchStrategy.constructor

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:143

Properties​

baseURL​

• baseURL: string = ''

The base URL where the API is located

Inherited from​

AbstractFetchStrategy.baseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

defaultParams​

• defaultParams: Partial<EndpointParams> = {}

The Default Params

Inherited from​

AbstractFetchStrategy.defaultParams

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:119

endpoint​

• endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from​

AbstractFetchStrategy.endpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:124

Methods​

buildEndpointURL​

▸ buildEndpointURL(params): string

Builds the final endpoint URL based on the passed parameters

Parameters​

NameTypeDescription
paramsPartial<VerifyTokenParams>The params to add to the request

Returns​

string

The endpoint URL.

Overrides​

AbstractFetchStrategy.buildEndpointURL

Defined in​

packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:32

fetcher​

▸ fetcher(url, params, options?): Promise<FetchResponse<AppEntity>>

The default fetcher function

The default fetcher function handles authentication headers and errors from the API.

A custom strategy can override this function to run additional logic before or after the fetch call

Parameters​

NameTypeDescription
urlstringThe URL to fetch
paramsVerifyTokenParamsThe request params
optionsPartial<FetchOptions>The fetcher options

Returns​

Promise<FetchResponse<AppEntity>>

Overrides​

AbstractFetchStrategy.fetcher

Defined in​

packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:39

filterData​

▸ filterData(data, filterOptions?): FetchResponse<AppEntity>

Filters the data returned from the API by excluding fields that are not needed in order to reduce -payload size.

Parameters​

NameTypeDescription
dataFetchResponse<AppEntity>The data to filter
filterOptions?FilterDataOptions<AppEntity>Filter options

Returns​

FetchResponse<AppEntity>

The filtered data

Inherited from​

AbstractFetchStrategy.filterData

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:377

get​

▸ get(params?): Promise<FetchResponse<AppEntity>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage​

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters​

NameTypeDescription
paramsPartial<EndpointParams>The endpoint params

Returns​

Promise<FetchResponse<AppEntity>>

Inherited from​

AbstractFetchStrategy.get

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:442

getAuthHeader​

▸ getAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

AbstractFetchStrategy.getAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:256

getCacheKey​

▸ getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters​

NameTypeDescription
paramsPartial<EndpointParams>The request params

Returns​

Object

The cache key object

NameType
argsPartial<EndpointParams> & { sourceUrl: string }
urlstring

Inherited from​

AbstractFetchStrategy.getCacheKey

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:407

getDefaultEndpoint​

▸ getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint -for the strategy

Returns​

string

Overrides​

AbstractFetchStrategy.getDefaultEndpoint

Defined in​

packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:23

getDefaultParams​

▸ getDefaultParams(): Partial<EndpointParams>

Returns​

Partial<EndpointParams>

Inherited from​

AbstractFetchStrategy.getDefaultParams

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:182

getEndpoint​

▸ getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, -returns the default endpoint

Returns​

string

The current endpoint for the strategy

Inherited from​

AbstractFetchStrategy.getEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:174

getParamsFromURL​

▸ getParamsFromURL(path, params?): Partial<EndpointParams>

Returns the supported params from the URL if present.

These params are passed to buildEndpointURL. If the strategy does not support -mapping url params to endpoint params, it should return an empty object.

Parameters​

NameTypeDescription
pathstringThe Path name
paramsPartial<EndpointParams>The non-url params

Returns​

Partial<EndpointParams>

params extracted from the URL

Overrides​

AbstractFetchStrategy.getParamsFromURL

Defined in​

packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:28

getPreviewAuthHeader​

▸ getPreviewAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

AbstractFetchStrategy.getPreviewAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:247

getPreviewHeaderName​

▸ getPreviewHeaderName(options?): "X-HeadstartWP-Authorization" | "Authorization"

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

"X-HeadstartWP-Authorization" | "Authorization"

Inherited from​

AbstractFetchStrategy.getPreviewHeaderName

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:241

getQueriedObject​

▸ getQueriedObject(response, params): Object

Parameters​

NameType
responseFetchResponse<AppEntity>
paramsPartial<EndpointParams>

Returns​

Object

Inherited from​

AbstractFetchStrategy.getQueriedObject

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:365

isMainQuery​

▸ isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters​

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<EndpointParams>The non-url params

Returns​

boolean

Inherited from​

AbstractFetchStrategy.isMainQuery

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:205

normalizeForCache​

▸ normalizeForCache(data, params): NormalizedDataForCache<AppEntity, EndpointParams>

Normalize data for cache.

Parameters​

NameTypeDescription
dataFetchResponse<AppEntity>The fetch response data
paramsPartial<EndpointParams>The request params

Returns​

NormalizedDataForCache<AppEntity, EndpointParams>

Inherited from​

AbstractFetchStrategy.normalizeForCache

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:417

prepareResponse​

▸ prepareResponse(response, params): FetchResponse<AppEntity>

Parameters​

NameType
responseFetchResponse<AppEntity>
paramsPartial<EndpointParams>

Returns​

FetchResponse<AppEntity>

Inherited from​

AbstractFetchStrategy.prepareResponse

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:233

setBaseURL​

▸ setBaseURL(url?): void

Parameters​

NameTypeDefault value
urlundefined | string''

Returns​

void

Inherited from​

AbstractFetchStrategy.setBaseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:164

setEndpoint​

▸ setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters​

NameTypeDescription
endpointstringThe endpoint to fetch

Returns​

void

Inherited from​

AbstractFetchStrategy.setEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +headless wp plugin

Hierarchy​

Constructors​

constructor​

• new VerifyTokenFetchStrategy(baseURL?, defaultParams?)

The strategy constructor

Parameters​

NameTypeDescription
baseURL?stringThe base URL of the API
defaultParams?Partial<EndpointParams>(optional) list of default params

Inherited from​

AbstractFetchStrategy.constructor

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:143

Properties​

baseURL​

• baseURL: string = ''

The base URL where the API is located

Inherited from​

AbstractFetchStrategy.baseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:129

defaultParams​

• defaultParams: Partial<EndpointParams> = {}

The Default Params

Inherited from​

AbstractFetchStrategy.defaultParams

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:119

endpoint​

• endpoint: string = ''

Holds the current endpoint for the strategy

Inherited from​

AbstractFetchStrategy.endpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:124

Methods​

buildEndpointURL​

▸ buildEndpointURL(params): string

Builds the final endpoint URL based on the passed parameters

Parameters​

NameTypeDescription
paramsPartial<VerifyTokenParams>The params to add to the request

Returns​

string

The endpoint URL.

Overrides​

AbstractFetchStrategy.buildEndpointURL

Defined in​

packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:32

fetcher​

▸ fetcher(url, params, options?): Promise<FetchResponse<AppEntity>>

The default fetcher function

The default fetcher function handles authentication headers and errors from the API.

A custom strategy can override this function to run additional logic before or after the fetch call

Parameters​

NameTypeDescription
urlstringThe URL to fetch
paramsVerifyTokenParamsThe request params
optionsPartial<FetchOptions>The fetcher options

Returns​

Promise<FetchResponse<AppEntity>>

Overrides​

AbstractFetchStrategy.fetcher

Defined in​

packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:39

filterData​

▸ filterData(data, filterOptions?): FetchResponse<AppEntity>

Filters the data returned from the API by excluding fields that are not needed in order to reduce +payload size.

Parameters​

NameTypeDescription
dataFetchResponse<AppEntity>The data to filter
filterOptions?FilterDataOptions<AppEntity>Filter options

Returns​

FetchResponse<AppEntity>

The filtered data

Inherited from​

AbstractFetchStrategy.filterData

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:377

get​

▸ get(params?): Promise<FetchResponse<AppEntity>>

This is a simple wrapper to quickly fetch data from the API given a set of params

Usage​

import { PostsArchiveFetchStrategy } from '@headstartwp/core';

new PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});

Parameters​

NameTypeDescription
paramsPartial<EndpointParams>The endpoint params

Returns​

Promise<FetchResponse<AppEntity>>

Inherited from​

AbstractFetchStrategy.get

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:442

getAuthHeader​

▸ getAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

AbstractFetchStrategy.getAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:256

getCacheKey​

▸ getCacheKey(params): Object

Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites

Parameters​

NameTypeDescription
paramsPartial<EndpointParams>The request params

Returns​

Object

The cache key object

NameType
argsPartial<EndpointParams> & { sourceUrl: string }
urlstring

Inherited from​

AbstractFetchStrategy.getCacheKey

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:407

getDefaultEndpoint​

▸ getDefaultEndpoint(): string

A method that must be implemented by concrete implementations which returns the default endpoint +for the strategy

Returns​

string

Overrides​

AbstractFetchStrategy.getDefaultEndpoint

Defined in​

packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:23

getDefaultParams​

▸ getDefaultParams(): Partial<EndpointParams>

Returns​

Partial<EndpointParams>

Inherited from​

AbstractFetchStrategy.getDefaultParams

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:182

getEndpoint​

▸ getEndpoint(): string

Returns the endpoint of the strategy. If no endpoint has been set at runtime, +returns the default endpoint

Returns​

string

The current endpoint for the strategy

Inherited from​

AbstractFetchStrategy.getEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:174

getParamsFromURL​

▸ getParamsFromURL(path, params?): Partial<EndpointParams>

Returns the supported params from the URL if present.

These params are passed to buildEndpointURL. If the strategy does not support +mapping url params to endpoint params, it should return an empty object.

Parameters​

NameTypeDescription
pathstringThe Path name
paramsPartial<EndpointParams>The non-url params

Returns​

Partial<EndpointParams>

params extracted from the URL

Overrides​

AbstractFetchStrategy.getParamsFromURL

Defined in​

packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:28

getPreviewAuthHeader​

▸ getPreviewAuthHeader(options?): string

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

string

Inherited from​

AbstractFetchStrategy.getPreviewAuthHeader

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:247

getPreviewHeaderName​

▸ getPreviewHeaderName(options?): "X-HeadstartWP-Authorization" | "Authorization"

Parameters​

NameType
optionsPartial<FetchOptions>

Returns​

"X-HeadstartWP-Authorization" | "Authorization"

Inherited from​

AbstractFetchStrategy.getPreviewHeaderName

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:241

getQueriedObject​

▸ getQueriedObject(response, params): Object

Parameters​

NameType
responseFetchResponse<AppEntity>
paramsPartial<EndpointParams>

Returns​

Object

Inherited from​

AbstractFetchStrategy.getQueriedObject

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:365

isMainQuery​

▸ isMainQuery(path, nonUrlParams): boolean

Checks if this is the main query for a page

Parameters​

NameTypeDescription
pathstringThe page name
nonUrlParamsPartial<EndpointParams>The non-url params

Returns​

boolean

Inherited from​

AbstractFetchStrategy.isMainQuery

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:205

normalizeForCache​

▸ normalizeForCache(data, params): NormalizedDataForCache<AppEntity, EndpointParams>

Normalize data for cache.

Parameters​

NameTypeDescription
dataFetchResponse<AppEntity>The fetch response data
paramsPartial<EndpointParams>The request params

Returns​

NormalizedDataForCache<AppEntity, EndpointParams>

Inherited from​

AbstractFetchStrategy.normalizeForCache

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:417

prepareResponse​

▸ prepareResponse(response, params): FetchResponse<AppEntity>

Parameters​

NameType
responseFetchResponse<AppEntity>
paramsPartial<EndpointParams>

Returns​

FetchResponse<AppEntity>

Inherited from​

AbstractFetchStrategy.prepareResponse

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:233

setBaseURL​

▸ setBaseURL(url?): void

Parameters​

NameTypeDefault value
urlundefined | string''

Returns​

void

Inherited from​

AbstractFetchStrategy.setBaseURL

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:164

setEndpoint​

▸ setEndpoint(endpoint): void

The strategy can switch endpoints at runtime if needed.

E.g: The actual endpoint for a post depends on its post_type

Parameters​

NameTypeDescription
endpointstringThe endpoint to fetch

Returns​

void

Inherited from​

AbstractFetchStrategy.setEndpoint

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:160

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/enums/headstartwp_core.LOGTYPE/index.html b/api/enums/headstartwp_core.LOGTYPE/index.html index be7e4773e..d5fa69ceb 100644 --- a/api/enums/headstartwp_core.LOGTYPE/index.html +++ b/api/enums/headstartwp_core.LOGTYPE/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content
Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content
Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/index.html b/api/index.html index e6afa2534..5317fbe38 100644 --- a/api/index.html +++ b/api/index.html @@ -7,13 +7,13 @@ - - + +
Skip to main content
Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - + + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.AppEntity/index.html b/api/interfaces/headstartwp_core.AppEntity/index.html index 00ac2b1ad..76f75fbee 100644 --- a/api/interfaces/headstartwp_core.AppEntity/index.html +++ b/api/interfaces/headstartwp_core.AppEntity/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: AppEntity

@headstartwp/core.AppEntity

Empty interface from which all entities inherit.

Hierarchy​

Properties​

home​

• home: Object

Type declaration​

NameType
id?number
slug?string

Defined in​

packages/core/src/data/types/entities.ts:739

• menus: Object

Index signature​

▪ [k: string]: MenuItemEntity[]

Defined in​

packages/core/src/data/types/entities.ts:736

settings​

• settings: Object

Type declaration​

NameType
posts_per_pagestring
privacy_policy_urlstring
site_descstring
site_namestring
site_rss_urlstring
site_wp_urlstring

Defined in​

packages/core/src/data/types/entities.ts:743

theme.json​

• theme.json: Record<string, any>

Defined in​

packages/core/src/data/types/entities.ts:751

yoast_head​

• Optional yoast_head: null | string

Inherited from​

Entity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:14

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Inherited from​

Entity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:13

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: AppEntity

@headstartwp/core.AppEntity

Empty interface from which all entities inherit.

Hierarchy​

Properties​

home​

• home: Object

Type declaration​

NameType
id?number
slug?string

Defined in​

packages/core/src/data/types/entities.ts:739

• menus: Object

Index signature​

▪ [k: string]: MenuItemEntity[]

Defined in​

packages/core/src/data/types/entities.ts:736

settings​

• settings: Object

Type declaration​

NameType
posts_per_pagestring
privacy_policy_urlstring
site_descstring
site_namestring
site_rss_urlstring
site_wp_urlstring

Defined in​

packages/core/src/data/types/entities.ts:743

theme.json​

• theme.json: Record<string, any>

Defined in​

packages/core/src/data/types/entities.ts:751

yoast_head​

• Optional yoast_head: null | string

Inherited from​

Entity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:14

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Inherited from​

Entity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:13

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.AttachmentEntity/index.html b/api/interfaces/headstartwp_core.AttachmentEntity/index.html index 81ff74cd2..ed0cc66fb 100644 --- a/api/interfaces/headstartwp_core.AttachmentEntity/index.html +++ b/api/interfaces/headstartwp_core.AttachmentEntity/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: AttachmentEntity

@headstartwp/core.AttachmentEntity

Interface for entities from the /wp/v2/media endpoint.

Hierarchy​

Properties​

_embedded​

• _embedded: Object

Type declaration​

NameType
authorAuthorEntity[]
wp:termTermEntity[][]

Inherited from​

PostTypeEntity._embedded

Defined in​

packages/core/src/data/types/entities.ts:98

alt_text​

• alt_text: string

Alternative text to display when attachment is not displayed.

Defined in​

packages/core/src/data/types/entities.ts:259

author​

• Optional author: AuthorEntity[]

Inherited from​

PostTypeEntity.author

Defined in​

packages/core/src/data/types/entities.ts:94

caption​

• caption: Rendered

The attachment caption.

Defined in​

packages/core/src/data/types/entities.ts:264

comment_status​

• Optional comment_status: "open" | "closed"

Whether or not comments are open on the object.

Inherited from​

PostTypeEntity.comment_status

Defined in​

packages/core/src/data/types/entities.ts:106

date​

• date: string

The date the object was published, in the site's timezone.

Inherited from​

PostTypeEntity.date

Defined in​

packages/core/src/data/types/entities.ts:42

date_gmt​

• date_gmt: string

The date the object was published, as GMT.

Inherited from​

PostTypeEntity.date_gmt

Defined in​

packages/core/src/data/types/entities.ts:47

description​

• description: Rendered

The attachment description.

Defined in​

packages/core/src/data/types/entities.ts:269

guid​

• guid: Rendered

The globally unique identifier for the object.

Inherited from​

PostTypeEntity.guid

Defined in​

packages/core/src/data/types/entities.ts:52

id​

• id: number

Unique identifier for the object.

Inherited from​

PostTypeEntity.id

Defined in​

packages/core/src/data/types/entities.ts:67

• link: string

URL to the object.

Inherited from​

PostTypeEntity.link

Defined in​

packages/core/src/data/types/entities.ts:72

media_details​

• Optional media_details: Object

Details about the media file, specific to its type.

Type declaration​

NameTypeDescription
filestringThe file path relative to wp-content/uploads.
heightnumberThe height of the attachment.
image_metaRecord<string, unknown>The metadata of the attachment.
sizesRecord<string, { file: string ; height: number ; mime_type: string ; source_url: string ; width: number }>The different sizes that WordPress created for this attachment.
widthnumberThe width of the attachment.

Defined in​

packages/core/src/data/types/entities.ts:284

media_type​

• media_type: "image" | "file"

Attachment type.

Defined in​

packages/core/src/data/types/entities.ts:274

meta​

• Optional meta: Record<string, unknown>

Meta fields.

Defined in​

packages/core/src/data/types/entities.ts:249

mime_type​

• mime_type: string

The attachment MIME type.

Defined in​

packages/core/src/data/types/entities.ts:279

missing_image_sizes​

• missing_image_sizes: string[]

List of the missing image sizes of the attachment.

Defined in​

packages/core/src/data/types/entities.ts:352

modified​

• modified: string

The date the object was last modified, in the site's timezone.

Inherited from​

PostTypeEntity.modified

Defined in​

packages/core/src/data/types/entities.ts:57

modified_gmt​

• modified_gmt: string

The date the object was last modified, as GMT.

Inherited from​

PostTypeEntity.modified_gmt

Defined in​

packages/core/src/data/types/entities.ts:62

ping_status​

• ping_status: "open" | "closed"

Whether or not the object can be pinged.

Inherited from​

PostTypeEntity.ping_status

Defined in​

packages/core/src/data/types/entities.ts:111

post​

• post: number

The ID for the associated post of the attachment.

Defined in​

packages/core/src/data/types/entities.ts:342

slug​

• slug: string

An alphanumeric identifier for the object unique to its type.

Inherited from​

PostTypeEntity.slug

Defined in​

packages/core/src/data/types/entities.ts:77

source_url​

• source_url: string

URL to the original attachment file.

Defined in​

packages/core/src/data/types/entities.ts:347

status​

• status: "publish" | "future" | "draft" | "pending" | "private"

A named status for the object.

Inherited from​

PostTypeEntity.status

Defined in​

packages/core/src/data/types/entities.ts:82

template​

• Optional template: string

The theme file to use to display the object.

Defined in​

packages/core/src/data/types/entities.ts:254

terms​

• Optional terms: Record<string, TermEntity[]>

Inherited from​

PostTypeEntity.terms

Defined in​

packages/core/src/data/types/entities.ts:96

title​

• title: Rendered

The title for the object.

Inherited from​

PostTypeEntity.title

Defined in​

packages/core/src/data/types/entities.ts:92

type​

• type: "attachment"

Type of Post for the object.

Overrides​

PostTypeEntity.type

Defined in​

packages/core/src/data/types/entities.ts:244

yoast_head​

• Optional yoast_head: null | string

Inherited from​

PostTypeEntity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:114

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Inherited from​

PostTypeEntity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:113

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: AttachmentEntity

@headstartwp/core.AttachmentEntity

Interface for entities from the /wp/v2/media endpoint.

Hierarchy​

Properties​

_embedded​

• _embedded: Object

Type declaration​

NameType
authorAuthorEntity[]
wp:termTermEntity[][]

Inherited from​

PostTypeEntity._embedded

Defined in​

packages/core/src/data/types/entities.ts:98

alt_text​

• alt_text: string

Alternative text to display when attachment is not displayed.

Defined in​

packages/core/src/data/types/entities.ts:259

author​

• Optional author: AuthorEntity[]

Inherited from​

PostTypeEntity.author

Defined in​

packages/core/src/data/types/entities.ts:94

caption​

• caption: Rendered

The attachment caption.

Defined in​

packages/core/src/data/types/entities.ts:264

comment_status​

• Optional comment_status: "open" | "closed"

Whether or not comments are open on the object.

Inherited from​

PostTypeEntity.comment_status

Defined in​

packages/core/src/data/types/entities.ts:106

date​

• date: string

The date the object was published, in the site's timezone.

Inherited from​

PostTypeEntity.date

Defined in​

packages/core/src/data/types/entities.ts:42

date_gmt​

• date_gmt: string

The date the object was published, as GMT.

Inherited from​

PostTypeEntity.date_gmt

Defined in​

packages/core/src/data/types/entities.ts:47

description​

• description: Rendered

The attachment description.

Defined in​

packages/core/src/data/types/entities.ts:269

guid​

• guid: Rendered

The globally unique identifier for the object.

Inherited from​

PostTypeEntity.guid

Defined in​

packages/core/src/data/types/entities.ts:52

id​

• id: number

Unique identifier for the object.

Inherited from​

PostTypeEntity.id

Defined in​

packages/core/src/data/types/entities.ts:67

• link: string

URL to the object.

Inherited from​

PostTypeEntity.link

Defined in​

packages/core/src/data/types/entities.ts:72

media_details​

• Optional media_details: Object

Details about the media file, specific to its type.

Type declaration​

NameTypeDescription
filestringThe file path relative to wp-content/uploads.
heightnumberThe height of the attachment.
image_metaRecord<string, unknown>The metadata of the attachment.
sizesRecord<string, { file: string ; height: number ; mime_type: string ; source_url: string ; width: number }>The different sizes that WordPress created for this attachment.
widthnumberThe width of the attachment.

Defined in​

packages/core/src/data/types/entities.ts:284

media_type​

• media_type: "image" | "file"

Attachment type.

Defined in​

packages/core/src/data/types/entities.ts:274

meta​

• Optional meta: Record<string, unknown>

Meta fields.

Defined in​

packages/core/src/data/types/entities.ts:249

mime_type​

• mime_type: string

The attachment MIME type.

Defined in​

packages/core/src/data/types/entities.ts:279

missing_image_sizes​

• missing_image_sizes: string[]

List of the missing image sizes of the attachment.

Defined in​

packages/core/src/data/types/entities.ts:352

modified​

• modified: string

The date the object was last modified, in the site's timezone.

Inherited from​

PostTypeEntity.modified

Defined in​

packages/core/src/data/types/entities.ts:57

modified_gmt​

• modified_gmt: string

The date the object was last modified, as GMT.

Inherited from​

PostTypeEntity.modified_gmt

Defined in​

packages/core/src/data/types/entities.ts:62

ping_status​

• ping_status: "open" | "closed"

Whether or not the object can be pinged.

Inherited from​

PostTypeEntity.ping_status

Defined in​

packages/core/src/data/types/entities.ts:111

post​

• post: number

The ID for the associated post of the attachment.

Defined in​

packages/core/src/data/types/entities.ts:342

slug​

• slug: string

An alphanumeric identifier for the object unique to its type.

Inherited from​

PostTypeEntity.slug

Defined in​

packages/core/src/data/types/entities.ts:77

source_url​

• source_url: string

URL to the original attachment file.

Defined in​

packages/core/src/data/types/entities.ts:347

status​

• status: "publish" | "future" | "draft" | "pending" | "private"

A named status for the object.

Inherited from​

PostTypeEntity.status

Defined in​

packages/core/src/data/types/entities.ts:82

template​

• Optional template: string

The theme file to use to display the object.

Defined in​

packages/core/src/data/types/entities.ts:254

terms​

• Optional terms: Record<string, TermEntity[]>

Inherited from​

PostTypeEntity.terms

Defined in​

packages/core/src/data/types/entities.ts:96

title​

• title: Rendered

The title for the object.

Inherited from​

PostTypeEntity.title

Defined in​

packages/core/src/data/types/entities.ts:92

type​

• type: "attachment"

Type of Post for the object.

Overrides​

PostTypeEntity.type

Defined in​

packages/core/src/data/types/entities.ts:244

yoast_head​

• Optional yoast_head: null | string

Inherited from​

PostTypeEntity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:114

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Inherited from​

PostTypeEntity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:113

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.AuthorEntity/index.html b/api/interfaces/headstartwp_core.AuthorEntity/index.html index aeba87452..9079f3245 100644 --- a/api/interfaces/headstartwp_core.AuthorEntity/index.html +++ b/api/interfaces/headstartwp_core.AuthorEntity/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: AuthorEntity

@headstartwp/core.AuthorEntity

Interface for entities from the /wp/v2/users endpoint.

Hierarchy​

Properties​

avatar_urls​

• Optional avatar_urls: AvatarUrls

Avatar URLs for the user.

Defined in​

packages/core/src/data/types/entities.ts:540

description​

• description: string

Description of the user.

Defined in​

packages/core/src/data/types/entities.ts:525

id​

• id: number

Unique identifier for the user.

Defined in​

packages/core/src/data/types/entities.ts:510

• link: string

Author URL of the user.

Defined in​

packages/core/src/data/types/entities.ts:530

meta​

• meta: Record<string, unknown>

Meta fields.

Defined in​

packages/core/src/data/types/entities.ts:545

name​

• name: string

Display name for the user.

Defined in​

packages/core/src/data/types/entities.ts:515

slug​

• slug: string

An alphanumeric identifier for the user.

Defined in​

packages/core/src/data/types/entities.ts:535

url​

• url: string

URL of the user.

Defined in​

packages/core/src/data/types/entities.ts:520

yoast_head​

• Optional yoast_head: null | string

Overrides​

Entity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:548

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Overrides​

Entity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:547

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: AuthorEntity

@headstartwp/core.AuthorEntity

Interface for entities from the /wp/v2/users endpoint.

Hierarchy​

Properties​

avatar_urls​

• Optional avatar_urls: AvatarUrls

Avatar URLs for the user.

Defined in​

packages/core/src/data/types/entities.ts:540

description​

• description: string

Description of the user.

Defined in​

packages/core/src/data/types/entities.ts:525

id​

• id: number

Unique identifier for the user.

Defined in​

packages/core/src/data/types/entities.ts:510

• link: string

Author URL of the user.

Defined in​

packages/core/src/data/types/entities.ts:530

meta​

• meta: Record<string, unknown>

Meta fields.

Defined in​

packages/core/src/data/types/entities.ts:545

name​

• name: string

Display name for the user.

Defined in​

packages/core/src/data/types/entities.ts:515

slug​

• slug: string

An alphanumeric identifier for the user.

Defined in​

packages/core/src/data/types/entities.ts:535

url​

• url: string

URL of the user.

Defined in​

packages/core/src/data/types/entities.ts:520

yoast_head​

• Optional yoast_head: null | string

Overrides​

Entity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:548

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Overrides​

Entity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:547

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.AvatarUrls/index.html b/api/interfaces/headstartwp_core.AvatarUrls/index.html index 81b604551..12923068c 100644 --- a/api/interfaces/headstartwp_core.AvatarUrls/index.html +++ b/api/interfaces/headstartwp_core.AvatarUrls/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: AvatarUrls

@headstartwp/core.AvatarUrls

Map of avatar URLs by their size.

Indexable​

▪ [k: string]: unknown

Properties​

24​

• Optional 24: string

Avatar URL with image size of 24 pixels.

Defined in​

packages/core/src/data/types/entities.ts:489

48​

• Optional 48: string

Avatar URL with image size of 48 pixels.

Defined in​

packages/core/src/data/types/entities.ts:494

96​

• Optional 96: string

Avatar URL with image size of 96 pixels.

Defined in​

packages/core/src/data/types/entities.ts:499

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: AvatarUrls

@headstartwp/core.AvatarUrls

Map of avatar URLs by their size.

Indexable​

▪ [k: string]: unknown

Properties​

24​

• Optional 24: string

Avatar URL with image size of 24 pixels.

Defined in​

packages/core/src/data/types/entities.ts:489

48​

• Optional 48: string

Avatar URL with image size of 48 pixels.

Defined in​

packages/core/src/data/types/entities.ts:494

96​

• Optional 96: string

Avatar URL with image size of 96 pixels.

Defined in​

packages/core/src/data/types/entities.ts:499

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.CommentEntity/index.html b/api/interfaces/headstartwp_core.CommentEntity/index.html index 6246d03e6..d13af3b9e 100644 --- a/api/interfaces/headstartwp_core.CommentEntity/index.html +++ b/api/interfaces/headstartwp_core.CommentEntity/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: CommentEntity

@headstartwp/core.CommentEntity

Interface for entities from the /wp/v2/comments endpoint.

Hierarchy​

Properties​

author​

• author: number

The ID of the user object, if author was a user.

Defined in​

packages/core/src/data/types/entities.ts:563

author_avatar_urls​

• author_avatar_urls: AvatarUrls

Avatar URLs for the object author.

Defined in​

packages/core/src/data/types/entities.ts:623

author_email​

• author_email: string

Email address for the object author.

Defined in​

packages/core/src/data/types/entities.ts:568

author_name​

• author_name: string

Display name for the object author.

Defined in​

packages/core/src/data/types/entities.ts:573

author_url​

• author_url: string

URL for the object author.

Defined in​

packages/core/src/data/types/entities.ts:578

content​

• content: Rendered

The content for the object.

Defined in​

packages/core/src/data/types/entities.ts:583

date​

• date: string

The date the object was published, in the site's timezone.

Defined in​

packages/core/src/data/types/entities.ts:588

date_gmt​

• date_gmt: string

The date the object was published, as GMT.

Defined in​

packages/core/src/data/types/entities.ts:593

id​

• id: number

Unique identifier for the object.

Defined in​

packages/core/src/data/types/entities.ts:558

• link: string

URL to the object.

Defined in​

packages/core/src/data/types/entities.ts:598

meta​

• meta: Record<string, unknown>

Meta fields.

Defined in​

packages/core/src/data/types/entities.ts:628

parent​

• parent: number

The ID for the parent of the object.

Defined in​

packages/core/src/data/types/entities.ts:603

post​

• post: number

The ID of the associated post object.

Defined in​

packages/core/src/data/types/entities.ts:608

status​

• status: string

State of the object.

Defined in​

packages/core/src/data/types/entities.ts:613

type​

• type: "comment"

Type of Comment for the object.

Defined in​

packages/core/src/data/types/entities.ts:618

yoast_head​

• Optional yoast_head: null | string

Inherited from​

Entity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:14

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Inherited from​

Entity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:13

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: CommentEntity

@headstartwp/core.CommentEntity

Interface for entities from the /wp/v2/comments endpoint.

Hierarchy​

Properties​

author​

• author: number

The ID of the user object, if author was a user.

Defined in​

packages/core/src/data/types/entities.ts:563

author_avatar_urls​

• author_avatar_urls: AvatarUrls

Avatar URLs for the object author.

Defined in​

packages/core/src/data/types/entities.ts:623

author_email​

• author_email: string

Email address for the object author.

Defined in​

packages/core/src/data/types/entities.ts:568

author_name​

• author_name: string

Display name for the object author.

Defined in​

packages/core/src/data/types/entities.ts:573

author_url​

• author_url: string

URL for the object author.

Defined in​

packages/core/src/data/types/entities.ts:578

content​

• content: Rendered

The content for the object.

Defined in​

packages/core/src/data/types/entities.ts:583

date​

• date: string

The date the object was published, in the site's timezone.

Defined in​

packages/core/src/data/types/entities.ts:588

date_gmt​

• date_gmt: string

The date the object was published, as GMT.

Defined in​

packages/core/src/data/types/entities.ts:593

id​

• id: number

Unique identifier for the object.

Defined in​

packages/core/src/data/types/entities.ts:558

• link: string

URL to the object.

Defined in​

packages/core/src/data/types/entities.ts:598

meta​

• meta: Record<string, unknown>

Meta fields.

Defined in​

packages/core/src/data/types/entities.ts:628

parent​

• parent: number

The ID for the parent of the object.

Defined in​

packages/core/src/data/types/entities.ts:603

post​

• post: number

The ID of the associated post object.

Defined in​

packages/core/src/data/types/entities.ts:608

status​

• status: string

State of the object.

Defined in​

packages/core/src/data/types/entities.ts:613

type​

• type: "comment"

Type of Comment for the object.

Defined in​

packages/core/src/data/types/entities.ts:618

yoast_head​

• Optional yoast_head: null | string

Inherited from​

Entity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:14

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Inherited from​

Entity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:13

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.EndpointParams/index.html b/api/interfaces/headstartwp_core.EndpointParams/index.html index 024952da0..9162bec57 100644 --- a/api/interfaces/headstartwp_core.EndpointParams/index.html +++ b/api/interfaces/headstartwp_core.EndpointParams/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: EndpointParams

@headstartwp/core.EndpointParams

The base interface for defining endpoint parameters

Strategies should define type with the actually supported EndPointParams

Hierarchy​

Indexable​

▪ [k: string]: unknown

Properties​

_embed​

• Optional _embed: boolean

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:17

_fields​

• Optional _fields: string[]

The _fields parameter is used to return only the specified fields in the response

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:22

lang​

• Optional lang: string

The polylang ?lang parameter.

This is only used if the polylang integration is enabled

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:29

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: EndpointParams

@headstartwp/core.EndpointParams

The base interface for defining endpoint parameters

Strategies should define type with the actually supported EndPointParams

Hierarchy​

Indexable​

▪ [k: string]: unknown

Properties​

_embed​

• Optional _embed: boolean

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:17

_fields​

• Optional _fields: string[]

The _fields parameter is used to return only the specified fields in the response

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:22

lang​

• Optional lang: string

The polylang ?lang parameter.

This is only used if the polylang integration is enabled

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:29

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.Entity/index.html b/api/interfaces/headstartwp_core.Entity/index.html index 9613c03a6..17f7cb7f2 100644 --- a/api/interfaces/headstartwp_core.Entity/index.html +++ b/api/interfaces/headstartwp_core.Entity/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: Entity

@headstartwp/core.Entity

Empty interface from which all entities inherit.

Hierarchy​

Indexable​

▪ [k: string]: unknown

Properties​

yoast_head​

• Optional yoast_head: null | string

Defined in​

packages/core/src/data/types/entities.ts:14

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Defined in​

packages/core/src/data/types/entities.ts:13

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: Entity

@headstartwp/core.Entity

Empty interface from which all entities inherit.

Hierarchy​

Indexable​

▪ [k: string]: unknown

Properties​

yoast_head​

• Optional yoast_head: null | string

Defined in​

packages/core/src/data/types/entities.ts:14

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Defined in​

packages/core/src/data/types/entities.ts:13

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.FetchOptions/index.html b/api/interfaces/headstartwp_core.FetchOptions/index.html index aee9fa7c3..0a81b5df3 100644 --- a/api/interfaces/headstartwp_core.FetchOptions/index.html +++ b/api/interfaces/headstartwp_core.FetchOptions/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: FetchOptions

@headstartwp/core.FetchOptions

The options supported by the default fetcher method

Properties​

alternativePreviewAuthorizationHeader​

• Optional alternativePreviewAuthorizationHeader: boolean

Flag to enable using the alternative authorization header.

This can be useful if you have separate authentication on your project.

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:80

bearerToken​

• Optional bearerToken: string

The authentication token to use for the request.

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:66

burstCache​

• Optional burstCache: boolean

Whether to burst cache by appending a timestamp to the query

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:85

previewToken​

• Optional previewToken: string

The preview token to use for the request.

These are tokens issued by the HeadstartWP plugin and is used to authenticate previews

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:73

throwIfNotFound​

• throwIfNotFound: boolean

Whether to thrown an exception if data is not found.

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:61

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: FetchOptions

@headstartwp/core.FetchOptions

The options supported by the default fetcher method

Properties​

alternativePreviewAuthorizationHeader​

• Optional alternativePreviewAuthorizationHeader: boolean

Flag to enable using the alternative authorization header.

This can be useful if you have separate authentication on your project.

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:80

bearerToken​

• Optional bearerToken: string

The authentication token to use for the request.

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:66

burstCache​

• Optional burstCache: boolean

Whether to burst cache by appending a timestamp to the query

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:85

previewToken​

• Optional previewToken: string

The preview token to use for the request.

These are tokens issued by the HeadstartWP plugin and is used to authenticate previews

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:73

throwIfNotFound​

• throwIfNotFound: boolean

Whether to thrown an exception if data is not found.

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:61

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.FetchResponse/index.html b/api/interfaces/headstartwp_core.FetchResponse/index.html index b9618923d..438a36ad5 100644 --- a/api/interfaces/headstartwp_core.FetchResponse/index.html +++ b/api/interfaces/headstartwp_core.FetchResponse/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: FetchResponse<T>

@headstartwp/core.FetchResponse

The type of the fetch response

Type parameters​

Name
T

Properties​

pageInfo​

• pageInfo: PageInfo

Contains pagination information

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:46

queriedObject​

• queriedObject: QueriedObject

Queried Object information

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:51

result​

• result: T

Contains the actual data returned from the API

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:41

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: FetchResponse<T>

@headstartwp/core.FetchResponse

The type of the fetch response

Type parameters​

Name
T

Properties​

pageInfo​

• pageInfo: PageInfo

Contains pagination information

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:46

queriedObject​

• queriedObject: QueriedObject

Queried Object information

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:51

result​

• result: T

Contains the actual data returned from the API

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:41

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.FilterDataOptions/index.html b/api/interfaces/headstartwp_core.FilterDataOptions/index.html index 499e00ba6..bc0ee3f76 100644 --- a/api/interfaces/headstartwp_core.FilterDataOptions/index.html +++ b/api/interfaces/headstartwp_core.FilterDataOptions/index.html @@ -7,14 +7,14 @@ - - + +
-
Skip to main content

Interface: FilterDataOptions<T>

@headstartwp/core.FilterDataOptions

Type parameters​

Name
T

Properties​

fields​

• fields: keyof T[]

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:94

method​

• method: "ALLOW" | "REMOVE"

If method is 'ALLOW' then only the fields specified in the filter will be returned. -If method is 'REMOVE' then the fields specified in the filter will be removed.

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:93

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: FilterDataOptions<T>

@headstartwp/core.FilterDataOptions

Type parameters​

Name
T

Properties​

fields​

• fields: keyof T[]

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:94

method​

• method: "ALLOW" | "REMOVE"

If method is 'ALLOW' then only the fields specified in the filter will be returned. +If method is 'REMOVE' then the fields specified in the filter will be removed.

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:93

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.HTMLReactParserOptions/index.html b/api/interfaces/headstartwp_core.HTMLReactParserOptions/index.html index 9f502d466..ae0cec406 100644 --- a/api/interfaces/headstartwp_core.HTMLReactParserOptions/index.html +++ b/api/interfaces/headstartwp_core.HTMLReactParserOptions/index.html @@ -7,13 +7,13 @@ - - + +
Skip to main content

Interface: HTMLReactParserOptions

@headstartwp/core.HTMLReactParserOptions

Properties​

htmlparser2​

• Optional htmlparser2: HTMLParser2Options

Defined in​

node_modules/html-react-parser/index.d.ts:24

library​

• Optional library: Object

Index signature​

▪ [key: string]: any

Type declaration​

NameType
cloneElement(element: Element, props?: object, ...children: any) => Element
createElement(type: any, props?: object, ...children: any) => Element
isValidElement(element: any) => boolean

Defined in​

node_modules/html-react-parser/index.d.ts:26

replace​

• Optional replace: (domNode: DOMNode) => undefined | null | false | void | object | Element

Type declaration​

▸ (domNode): undefined | null | false | void | object | Element

Parameters​
NameType
domNodeDOMNode
Returns​

undefined | null | false | void | object | Element

Defined in​

node_modules/html-react-parser/index.d.ts:37

trim​

• Optional trim: boolean

Defined in​

node_modules/html-react-parser/index.d.ts:41

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - + + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.Integration/index.html b/api/interfaces/headstartwp_core.Integration/index.html index afba14136..7cfe42039 100644 --- a/api/interfaces/headstartwp_core.Integration/index.html +++ b/api/interfaces/headstartwp_core.Integration/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content
Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content
Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.MenuItemEntity/index.html b/api/interfaces/headstartwp_core.MenuItemEntity/index.html index 50baa5624..e7d89cc8b 100644 --- a/api/interfaces/headstartwp_core.MenuItemEntity/index.html +++ b/api/interfaces/headstartwp_core.MenuItemEntity/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: MenuItemEntity

@headstartwp/core.MenuItemEntity

Properties​

ID​

• ID: number

Defined in​

packages/core/src/data/types/entities.ts:715

attr_title​

• attr_title: string

Defined in​

packages/core/src/data/types/entities.ts:727

children​

• children: MenuItemEntity[]

Defined in​

packages/core/src/data/types/entities.ts:731

classes​

• classes: string[]

Defined in​

packages/core/src/data/types/entities.ts:729

description​

• description: string

Defined in​

packages/core/src/data/types/entities.ts:728

• menu_item_parent: string

Defined in​

packages/core/src/data/types/entities.ts:719

• menu_order: number

Defined in​

packages/core/src/data/types/entities.ts:716

object​

• object: string

Defined in​

packages/core/src/data/types/entities.ts:721

object_id​

• object_id: string

Defined in​

packages/core/src/data/types/entities.ts:720

order​

• order: number

Defined in​

packages/core/src/data/types/entities.ts:732

post_mime_type​

• post_mime_type: string

Defined in​

packages/core/src/data/types/entities.ts:718

post_type​

• post_type: string

Defined in​

packages/core/src/data/types/entities.ts:717

slug​

• slug: string

Defined in​

packages/core/src/data/types/entities.ts:730

target​

• target: "_blank" | "_self" | "_parent" | "_top"

Defined in​

packages/core/src/data/types/entities.ts:726

title​

• title: string

Defined in​

packages/core/src/data/types/entities.ts:725

type​

• type: string

Defined in​

packages/core/src/data/types/entities.ts:722

type_label​

• type_label: string

Defined in​

packages/core/src/data/types/entities.ts:723

url​

• url: string

Defined in​

packages/core/src/data/types/entities.ts:724

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: MenuItemEntity

@headstartwp/core.MenuItemEntity

Properties​

ID​

• ID: number

Defined in​

packages/core/src/data/types/entities.ts:715

attr_title​

• attr_title: string

Defined in​

packages/core/src/data/types/entities.ts:727

children​

• children: MenuItemEntity[]

Defined in​

packages/core/src/data/types/entities.ts:731

classes​

• classes: string[]

Defined in​

packages/core/src/data/types/entities.ts:729

description​

• description: string

Defined in​

packages/core/src/data/types/entities.ts:728

• menu_item_parent: string

Defined in​

packages/core/src/data/types/entities.ts:719

• menu_order: number

Defined in​

packages/core/src/data/types/entities.ts:716

object​

• object: string

Defined in​

packages/core/src/data/types/entities.ts:721

object_id​

• object_id: string

Defined in​

packages/core/src/data/types/entities.ts:720

order​

• order: number

Defined in​

packages/core/src/data/types/entities.ts:732

post_mime_type​

• post_mime_type: string

Defined in​

packages/core/src/data/types/entities.ts:718

post_type​

• post_type: string

Defined in​

packages/core/src/data/types/entities.ts:717

slug​

• slug: string

Defined in​

packages/core/src/data/types/entities.ts:730

target​

• target: "_blank" | "_self" | "_parent" | "_top"

Defined in​

packages/core/src/data/types/entities.ts:726

title​

• title: string

Defined in​

packages/core/src/data/types/entities.ts:725

type​

• type: string

Defined in​

packages/core/src/data/types/entities.ts:722

type_label​

• type_label: string

Defined in​

packages/core/src/data/types/entities.ts:723

url​

• url: string

Defined in​

packages/core/src/data/types/entities.ts:724

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.PageEntity/index.html b/api/interfaces/headstartwp_core.PageEntity/index.html index f76381705..959ec6caf 100644 --- a/api/interfaces/headstartwp_core.PageEntity/index.html +++ b/api/interfaces/headstartwp_core.PageEntity/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: PageEntity

@headstartwp/core.PageEntity

Interface for entities from the /wp/v2/pages endpoint.

Hierarchy​

Properties​

_embedded​

• _embedded: Object

Type declaration​

NameType
authorAuthorEntity[]
wp:termTermEntity[][]

Inherited from​

PostTypeEntity._embedded

Defined in​

packages/core/src/data/types/entities.ts:98

author​

• Optional author: AuthorEntity[]

Inherited from​

PostTypeEntity.author

Defined in​

packages/core/src/data/types/entities.ts:94

comment_status​

• Optional comment_status: "open" | "closed"

Whether or not comments are open on the object.

Inherited from​

PostTypeEntity.comment_status

Defined in​

packages/core/src/data/types/entities.ts:106

content​

• content: Rendered

The content for the object.

Defined in​

packages/core/src/data/types/entities.ts:209

date​

• date: string

The date the object was published, in the site's timezone.

Inherited from​

PostTypeEntity.date

Defined in​

packages/core/src/data/types/entities.ts:42

date_gmt​

• date_gmt: string

The date the object was published, as GMT.

Inherited from​

PostTypeEntity.date_gmt

Defined in​

packages/core/src/data/types/entities.ts:47

excerpt​

• excerpt: Rendered

The excerpt for the object.

Defined in​

packages/core/src/data/types/entities.ts:214

• featured_media: number

The ID of the featured media for the object.

Defined in​

packages/core/src/data/types/entities.ts:234

guid​

• guid: Rendered

The globally unique identifier for the object.

Inherited from​

PostTypeEntity.guid

Defined in​

packages/core/src/data/types/entities.ts:52

id​

• id: number

Unique identifier for the object.

Inherited from​

PostTypeEntity.id

Defined in​

packages/core/src/data/types/entities.ts:67

• link: string

URL to the object.

Inherited from​

PostTypeEntity.link

Defined in​

packages/core/src/data/types/entities.ts:72

• menu_order: number

The order of the object in relation to other object of its type.

Defined in​

packages/core/src/data/types/entities.ts:219

meta​

• meta: Record<string, unknown>

Meta fields.

Defined in​

packages/core/src/data/types/entities.ts:224

modified​

• modified: string

The date the object was last modified, in the site's timezone.

Inherited from​

PostTypeEntity.modified

Defined in​

packages/core/src/data/types/entities.ts:57

modified_gmt​

• modified_gmt: string

The date the object was last modified, as GMT.

Inherited from​

PostTypeEntity.modified_gmt

Defined in​

packages/core/src/data/types/entities.ts:62

parent​

• parent: number

The ID for the parent of the object.

Defined in​

packages/core/src/data/types/entities.ts:204

ping_status​

• ping_status: "open" | "closed"

Whether or not the object can be pinged.

Inherited from​

PostTypeEntity.ping_status

Defined in​

packages/core/src/data/types/entities.ts:111

slug​

• slug: string

An alphanumeric identifier for the object unique to its type.

Inherited from​

PostTypeEntity.slug

Defined in​

packages/core/src/data/types/entities.ts:77

status​

• status: "publish" | "future" | "draft" | "pending" | "private"

A named status for the object.

Inherited from​

PostTypeEntity.status

Defined in​

packages/core/src/data/types/entities.ts:82

template​

• template: string

The theme file to use to display the object.

Defined in​

packages/core/src/data/types/entities.ts:229

terms​

• Optional terms: Record<string, TermEntity[]>

Inherited from​

PostTypeEntity.terms

Defined in​

packages/core/src/data/types/entities.ts:96

title​

• title: Rendered

The title for the object.

Inherited from​

PostTypeEntity.title

Defined in​

packages/core/src/data/types/entities.ts:92

type​

• type: string

Type of Post for the object.

Inherited from​

PostTypeEntity.type

Defined in​

packages/core/src/data/types/entities.ts:87

yoast_head​

• Optional yoast_head: null | string

Inherited from​

PostTypeEntity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:114

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Inherited from​

PostTypeEntity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:113

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: PageEntity

@headstartwp/core.PageEntity

Interface for entities from the /wp/v2/pages endpoint.

Hierarchy​

Properties​

_embedded​

• _embedded: Object

Type declaration​

NameType
authorAuthorEntity[]
wp:termTermEntity[][]

Inherited from​

PostTypeEntity._embedded

Defined in​

packages/core/src/data/types/entities.ts:98

author​

• Optional author: AuthorEntity[]

Inherited from​

PostTypeEntity.author

Defined in​

packages/core/src/data/types/entities.ts:94

comment_status​

• Optional comment_status: "open" | "closed"

Whether or not comments are open on the object.

Inherited from​

PostTypeEntity.comment_status

Defined in​

packages/core/src/data/types/entities.ts:106

content​

• content: Rendered

The content for the object.

Defined in​

packages/core/src/data/types/entities.ts:209

date​

• date: string

The date the object was published, in the site's timezone.

Inherited from​

PostTypeEntity.date

Defined in​

packages/core/src/data/types/entities.ts:42

date_gmt​

• date_gmt: string

The date the object was published, as GMT.

Inherited from​

PostTypeEntity.date_gmt

Defined in​

packages/core/src/data/types/entities.ts:47

excerpt​

• excerpt: Rendered

The excerpt for the object.

Defined in​

packages/core/src/data/types/entities.ts:214

• featured_media: number

The ID of the featured media for the object.

Defined in​

packages/core/src/data/types/entities.ts:234

guid​

• guid: Rendered

The globally unique identifier for the object.

Inherited from​

PostTypeEntity.guid

Defined in​

packages/core/src/data/types/entities.ts:52

id​

• id: number

Unique identifier for the object.

Inherited from​

PostTypeEntity.id

Defined in​

packages/core/src/data/types/entities.ts:67

• link: string

URL to the object.

Inherited from​

PostTypeEntity.link

Defined in​

packages/core/src/data/types/entities.ts:72

• menu_order: number

The order of the object in relation to other object of its type.

Defined in​

packages/core/src/data/types/entities.ts:219

meta​

• meta: Record<string, unknown>

Meta fields.

Defined in​

packages/core/src/data/types/entities.ts:224

modified​

• modified: string

The date the object was last modified, in the site's timezone.

Inherited from​

PostTypeEntity.modified

Defined in​

packages/core/src/data/types/entities.ts:57

modified_gmt​

• modified_gmt: string

The date the object was last modified, as GMT.

Inherited from​

PostTypeEntity.modified_gmt

Defined in​

packages/core/src/data/types/entities.ts:62

parent​

• parent: number

The ID for the parent of the object.

Defined in​

packages/core/src/data/types/entities.ts:204

ping_status​

• ping_status: "open" | "closed"

Whether or not the object can be pinged.

Inherited from​

PostTypeEntity.ping_status

Defined in​

packages/core/src/data/types/entities.ts:111

slug​

• slug: string

An alphanumeric identifier for the object unique to its type.

Inherited from​

PostTypeEntity.slug

Defined in​

packages/core/src/data/types/entities.ts:77

status​

• status: "publish" | "future" | "draft" | "pending" | "private"

A named status for the object.

Inherited from​

PostTypeEntity.status

Defined in​

packages/core/src/data/types/entities.ts:82

template​

• template: string

The theme file to use to display the object.

Defined in​

packages/core/src/data/types/entities.ts:229

terms​

• Optional terms: Record<string, TermEntity[]>

Inherited from​

PostTypeEntity.terms

Defined in​

packages/core/src/data/types/entities.ts:96

title​

• title: Rendered

The title for the object.

Inherited from​

PostTypeEntity.title

Defined in​

packages/core/src/data/types/entities.ts:92

type​

• type: string

Type of Post for the object.

Inherited from​

PostTypeEntity.type

Defined in​

packages/core/src/data/types/entities.ts:87

yoast_head​

• Optional yoast_head: null | string

Inherited from​

PostTypeEntity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:114

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Inherited from​

PostTypeEntity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:113

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.PageInfo/index.html b/api/interfaces/headstartwp_core.PageInfo/index.html index 5e9f1788e..7447a7c35 100644 --- a/api/interfaces/headstartwp_core.PageInfo/index.html +++ b/api/interfaces/headstartwp_core.PageInfo/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content
Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content
Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.PolylangIntegration/index.html b/api/interfaces/headstartwp_core.PolylangIntegration/index.html index f2e1f5ff2..2db5e7397 100644 --- a/api/interfaces/headstartwp_core.PolylangIntegration/index.html +++ b/api/interfaces/headstartwp_core.PolylangIntegration/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content
Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content
Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.PostEntity/index.html b/api/interfaces/headstartwp_core.PostEntity/index.html index b53d030f2..5279f34ae 100644 --- a/api/interfaces/headstartwp_core.PostEntity/index.html +++ b/api/interfaces/headstartwp_core.PostEntity/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: PostEntity

@headstartwp/core.PostEntity

Interface for entities from the /wp/v2/posts endpoint.

Hierarchy​

Properties​

_embedded​

• _embedded: Object

Type declaration​

NameType
authorAuthorEntity[]
wp:termTermEntity[][]

Inherited from​

PostTypeEntity._embedded

Defined in​

packages/core/src/data/types/entities.ts:98

author​

• Optional author: AuthorEntity[]

Inherited from​

PostTypeEntity.author

Defined in​

packages/core/src/data/types/entities.ts:94

categories​

• Optional categories: number[]

The terms assigned to the object in the category taxonomy.

Defined in​

packages/core/src/data/types/entities.ts:164

comment_status​

• Optional comment_status: "open" | "closed"

Whether or not comments are open on the object.

Inherited from​

PostTypeEntity.comment_status

Defined in​

packages/core/src/data/types/entities.ts:106

content​

• content: Rendered

The content for the object.

Defined in​

packages/core/src/data/types/entities.ts:124

date​

• date: string

The date the object was published, in the site's timezone.

Inherited from​

PostTypeEntity.date

Defined in​

packages/core/src/data/types/entities.ts:42

date_gmt​

• date_gmt: string

The date the object was published, as GMT.

Inherited from​

PostTypeEntity.date_gmt

Defined in​

packages/core/src/data/types/entities.ts:47

excerpt​

• excerpt: Rendered

The excerpt for the object.

Defined in​

packages/core/src/data/types/entities.ts:129

• featured_media: number

The ID of the featured media for the object.

Defined in​

packages/core/src/data/types/entities.ts:174

format​

• format: "link" | "status" | "standard" | "aside" | "chat" | "gallery" | "image" | "quote" | "video" | "audio"

The format for the object.

Defined in​

packages/core/src/data/types/entities.ts:134

guid​

• guid: Rendered

The globally unique identifier for the object.

Inherited from​

PostTypeEntity.guid

Defined in​

packages/core/src/data/types/entities.ts:52

id​

• id: number

Unique identifier for the object.

Inherited from​

PostTypeEntity.id

Defined in​

packages/core/src/data/types/entities.ts:67

• link: string

URL to the object.

Inherited from​

PostTypeEntity.link

Defined in​

packages/core/src/data/types/entities.ts:72

meta​

• meta: Record<string, unknown>

Meta fields.

Defined in​

packages/core/src/data/types/entities.ts:149

modified​

• modified: string

The date the object was last modified, in the site's timezone.

Inherited from​

PostTypeEntity.modified

Defined in​

packages/core/src/data/types/entities.ts:57

modified_gmt​

• modified_gmt: string

The date the object was last modified, as GMT.

Inherited from​

PostTypeEntity.modified_gmt

Defined in​

packages/core/src/data/types/entities.ts:62

ping_status​

• ping_status: "open" | "closed"

Whether or not the object can be pinged.

Inherited from​

PostTypeEntity.ping_status

Defined in​

packages/core/src/data/types/entities.ts:111

slug​

• slug: string

An alphanumeric identifier for the object unique to its type.

Inherited from​

PostTypeEntity.slug

Defined in​

packages/core/src/data/types/entities.ts:77

status​

• status: "publish" | "future" | "draft" | "pending" | "private"

A named status for the object.

Inherited from​

PostTypeEntity.status

Defined in​

packages/core/src/data/types/entities.ts:82

sticky​

• sticky: boolean

Whether or not the object should be treated as sticky.

Defined in​

packages/core/src/data/types/entities.ts:154

tags​

• Optional tags: number[]

The terms assigned to the object in the post_tag taxonomy.

Defined in​

packages/core/src/data/types/entities.ts:169

template​

• template: string

The theme file to use to display the object.

Defined in​

packages/core/src/data/types/entities.ts:159

terms​

• Optional terms: Record<string, TermEntity[]>

Inherited from​

PostTypeEntity.terms

Defined in​

packages/core/src/data/types/entities.ts:96

title​

• title: Rendered

The title for the object.

Inherited from​

PostTypeEntity.title

Defined in​

packages/core/src/data/types/entities.ts:92

type​

• type: string

Type of Post for the object.

Inherited from​

PostTypeEntity.type

Defined in​

packages/core/src/data/types/entities.ts:87

yoast_head​

• Optional yoast_head: null | string

Inherited from​

PostTypeEntity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:114

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Inherited from​

PostTypeEntity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:113

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: PostEntity

@headstartwp/core.PostEntity

Interface for entities from the /wp/v2/posts endpoint.

Hierarchy​

Properties​

_embedded​

• _embedded: Object

Type declaration​

NameType
authorAuthorEntity[]
wp:termTermEntity[][]

Inherited from​

PostTypeEntity._embedded

Defined in​

packages/core/src/data/types/entities.ts:98

author​

• Optional author: AuthorEntity[]

Inherited from​

PostTypeEntity.author

Defined in​

packages/core/src/data/types/entities.ts:94

categories​

• Optional categories: number[]

The terms assigned to the object in the category taxonomy.

Defined in​

packages/core/src/data/types/entities.ts:164

comment_status​

• Optional comment_status: "open" | "closed"

Whether or not comments are open on the object.

Inherited from​

PostTypeEntity.comment_status

Defined in​

packages/core/src/data/types/entities.ts:106

content​

• content: Rendered

The content for the object.

Defined in​

packages/core/src/data/types/entities.ts:124

date​

• date: string

The date the object was published, in the site's timezone.

Inherited from​

PostTypeEntity.date

Defined in​

packages/core/src/data/types/entities.ts:42

date_gmt​

• date_gmt: string

The date the object was published, as GMT.

Inherited from​

PostTypeEntity.date_gmt

Defined in​

packages/core/src/data/types/entities.ts:47

excerpt​

• excerpt: Rendered

The excerpt for the object.

Defined in​

packages/core/src/data/types/entities.ts:129

• featured_media: number

The ID of the featured media for the object.

Defined in​

packages/core/src/data/types/entities.ts:174

format​

• format: "link" | "status" | "standard" | "aside" | "chat" | "gallery" | "image" | "quote" | "video" | "audio"

The format for the object.

Defined in​

packages/core/src/data/types/entities.ts:134

guid​

• guid: Rendered

The globally unique identifier for the object.

Inherited from​

PostTypeEntity.guid

Defined in​

packages/core/src/data/types/entities.ts:52

id​

• id: number

Unique identifier for the object.

Inherited from​

PostTypeEntity.id

Defined in​

packages/core/src/data/types/entities.ts:67

• link: string

URL to the object.

Inherited from​

PostTypeEntity.link

Defined in​

packages/core/src/data/types/entities.ts:72

meta​

• meta: Record<string, unknown>

Meta fields.

Defined in​

packages/core/src/data/types/entities.ts:149

modified​

• modified: string

The date the object was last modified, in the site's timezone.

Inherited from​

PostTypeEntity.modified

Defined in​

packages/core/src/data/types/entities.ts:57

modified_gmt​

• modified_gmt: string

The date the object was last modified, as GMT.

Inherited from​

PostTypeEntity.modified_gmt

Defined in​

packages/core/src/data/types/entities.ts:62

ping_status​

• ping_status: "open" | "closed"

Whether or not the object can be pinged.

Inherited from​

PostTypeEntity.ping_status

Defined in​

packages/core/src/data/types/entities.ts:111

slug​

• slug: string

An alphanumeric identifier for the object unique to its type.

Inherited from​

PostTypeEntity.slug

Defined in​

packages/core/src/data/types/entities.ts:77

status​

• status: "publish" | "future" | "draft" | "pending" | "private"

A named status for the object.

Inherited from​

PostTypeEntity.status

Defined in​

packages/core/src/data/types/entities.ts:82

sticky​

• sticky: boolean

Whether or not the object should be treated as sticky.

Defined in​

packages/core/src/data/types/entities.ts:154

tags​

• Optional tags: number[]

The terms assigned to the object in the post_tag taxonomy.

Defined in​

packages/core/src/data/types/entities.ts:169

template​

• template: string

The theme file to use to display the object.

Defined in​

packages/core/src/data/types/entities.ts:159

terms​

• Optional terms: Record<string, TermEntity[]>

Inherited from​

PostTypeEntity.terms

Defined in​

packages/core/src/data/types/entities.ts:96

title​

• title: Rendered

The title for the object.

Inherited from​

PostTypeEntity.title

Defined in​

packages/core/src/data/types/entities.ts:92

type​

• type: string

Type of Post for the object.

Inherited from​

PostTypeEntity.type

Defined in​

packages/core/src/data/types/entities.ts:87

yoast_head​

• Optional yoast_head: null | string

Inherited from​

PostTypeEntity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:114

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Inherited from​

PostTypeEntity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:113

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.PostOrPostsParams/index.html b/api/interfaces/headstartwp_core.PostOrPostsParams/index.html index b5c8b568c..a44b98abc 100644 --- a/api/interfaces/headstartwp_core.PostOrPostsParams/index.html +++ b/api/interfaces/headstartwp_core.PostOrPostsParams/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: PostOrPostsParams

@headstartwp/core.PostOrPostsParams

The params supported by PostOrPostsFetchStrategy

Hierarchy​

Properties​

_embed​

• Optional _embed: boolean

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data

Inherited from​

EndpointParams._embed

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:17

_fields​

• Optional _fields: string[]

The _fields parameter is used to return only the specified fields in the response

Inherited from​

EndpointParams._fields

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:22

archive​

• archive: Partial<PostsArchiveParams>

The archive params corresponds to PostsArchiveParams

Defined in​

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:25

lang​

• Optional lang: string

The polylang ?lang parameter.

This is only used if the polylang integration is enabled

Inherited from​

EndpointParams.lang

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:29

priority​

• priority: "archive" | "single"

The priority indicates which strategy should execute first.

Defined in​

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:30

routeMatchStrategy​

• routeMatchStrategy: "none" | "archive" | "single" | "both"

How to handle route matching strategy, the possible values are:

  • single will only trigger the single strategy if there's a url match for the single strategy
  • archive will only trigger the archive strategy if there's a url match for the archive strategy
  • both requires a route match for both single and archive

Defined in​

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:39

single​

• single: Partial<PostParams>

The single params corresponds to PostParams

Defined in​

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:20

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: PostOrPostsParams

@headstartwp/core.PostOrPostsParams

The params supported by PostOrPostsFetchStrategy

Hierarchy​

Properties​

_embed​

• Optional _embed: boolean

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data

Inherited from​

EndpointParams._embed

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:17

_fields​

• Optional _fields: string[]

The _fields parameter is used to return only the specified fields in the response

Inherited from​

EndpointParams._fields

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:22

archive​

• archive: Partial<PostsArchiveParams>

The archive params corresponds to PostsArchiveParams

Defined in​

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:25

lang​

• Optional lang: string

The polylang ?lang parameter.

This is only used if the polylang integration is enabled

Inherited from​

EndpointParams.lang

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:29

priority​

• priority: "archive" | "single"

The priority indicates which strategy should execute first.

Defined in​

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:30

routeMatchStrategy​

• routeMatchStrategy: "none" | "archive" | "single" | "both"

How to handle route matching strategy, the possible values are:

  • single will only trigger the single strategy if there's a url match for the single strategy
  • archive will only trigger the archive strategy if there's a url match for the archive strategy
  • both requires a route match for both single and archive

Defined in​

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:39

single​

• single: Partial<PostParams>

The single params corresponds to PostParams

Defined in​

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:20

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.PostParams/index.html b/api/interfaces/headstartwp_core.PostParams/index.html index d094c1636..d95ef05fa 100644 --- a/api/interfaces/headstartwp_core.PostParams/index.html +++ b/api/interfaces/headstartwp_core.PostParams/index.html @@ -7,14 +7,14 @@ - - + +
-
Skip to main content

Interface: PostParams

@headstartwp/core.PostParams

The EndpointParams supported by the SinglePostFetchStrategy

Hierarchy​

Properties​

_embed​

• Optional _embed: boolean

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data

Inherited from​

EndpointParams._embed

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:17

_fields​

• Optional _fields: string[]

The _fields parameter is used to return only the specified fields in the response

Inherited from​

EndpointParams._fields

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:22

authToken​

• Optional authToken: string

The authToken, required to fetch revisions or non-published posts

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:53

fullPath​

• Optional fullPath: string

If set, this is the path that will be checked if slug is set or matchCurrentPath is set to true.

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:63

id​

• Optional id: Number

Fetch post by id

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:43

lang​

• Optional lang: string

The polylang ?lang parameter.

This is only used if the polylang integration is enabled

Inherited from​

EndpointParams.lang

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:29

matchCurrentPath​

• Optional matchCurrentPath: boolean

Whether post.link should be checked against current path

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:58

postType​

• Optional postType: string | string[]

Post Types where we should look for

If multiple post types are specified -multiple requests will be issued to each post type until a matching post is found

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:38

revision​

• Optional revision: Boolean

If set will fetch the latest post revision

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:48

slug​

• Optional slug: string

The slug of the post to fetch

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:30

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: PostParams

@headstartwp/core.PostParams

The EndpointParams supported by the SinglePostFetchStrategy

Hierarchy​

Properties​

_embed​

• Optional _embed: boolean

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data

Inherited from​

EndpointParams._embed

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:17

_fields​

• Optional _fields: string[]

The _fields parameter is used to return only the specified fields in the response

Inherited from​

EndpointParams._fields

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:22

authToken​

• Optional authToken: string

The authToken, required to fetch revisions or non-published posts

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:53

fullPath​

• Optional fullPath: string

If set, this is the path that will be checked if slug is set or matchCurrentPath is set to true.

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:63

id​

• Optional id: Number

Fetch post by id

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:43

lang​

• Optional lang: string

The polylang ?lang parameter.

This is only used if the polylang integration is enabled

Inherited from​

EndpointParams.lang

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:29

matchCurrentPath​

• Optional matchCurrentPath: boolean

Whether post.link should be checked against current path

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:58

postType​

• Optional postType: string | string[]

Post Types where we should look for

If multiple post types are specified +multiple requests will be issued to each post type until a matching post is found

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:38

revision​

• Optional revision: Boolean

If set will fetch the latest post revision

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:48

slug​

• Optional slug: string

The slug of the post to fetch

Defined in​

packages/core/src/data/strategies/SinglePostFetchStrategy.ts:30

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.PostSearchEntity/index.html b/api/interfaces/headstartwp_core.PostSearchEntity/index.html index fa48ab4b4..7e485a1e8 100644 --- a/api/interfaces/headstartwp_core.PostSearchEntity/index.html +++ b/api/interfaces/headstartwp_core.PostSearchEntity/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: PostSearchEntity

@headstartwp/core.PostSearchEntity

Interface for posts entities from the /wp/v2/search endpoint.

Hierarchy​

Properties​

_embedded​

• _embedded: Object

Type declaration​

NameType
authorAuthorEntity[]
selfPostEntity[]
wp:termTermEntity[][]

Defined in​

packages/core/src/data/types/entities.ts:689

author​

• Optional author: AuthorEntity[]

Defined in​

packages/core/src/data/types/entities.ts:685

id​

• id: number

Unique identifier for the object.

Inherited from​

SearchObjectEntity.id

Defined in​

packages/core/src/data/types/entities.ts:658

subtype​

• subtype: string

Subtype of Search for the object.

Defined in​

packages/core/src/data/types/entities.ts:683

terms​

• Optional terms: Record<string, TermEntity[]>

Defined in​

packages/core/src/data/types/entities.ts:687

title​

• title: string

The title for the object.

Inherited from​

SearchObjectEntity.title

Defined in​

packages/core/src/data/types/entities.ts:668

type​

• type: "post" | "term" | "post-format"

Type of Search for the object.

Inherited from​

SearchObjectEntity.type

Defined in​

packages/core/src/data/types/entities.ts:673

url​

• url: string

URL to the object.

Inherited from​

SearchObjectEntity.url

Defined in​

packages/core/src/data/types/entities.ts:663

yoast_head​

• Optional yoast_head: null | string

Inherited from​

SearchObjectEntity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:14

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Inherited from​

SearchObjectEntity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:13

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: PostSearchEntity

@headstartwp/core.PostSearchEntity

Interface for posts entities from the /wp/v2/search endpoint.

Hierarchy​

Properties​

_embedded​

• _embedded: Object

Type declaration​

NameType
authorAuthorEntity[]
selfPostEntity[]
wp:termTermEntity[][]

Defined in​

packages/core/src/data/types/entities.ts:689

author​

• Optional author: AuthorEntity[]

Defined in​

packages/core/src/data/types/entities.ts:685

id​

• id: number

Unique identifier for the object.

Inherited from​

SearchObjectEntity.id

Defined in​

packages/core/src/data/types/entities.ts:658

subtype​

• subtype: string

Subtype of Search for the object.

Defined in​

packages/core/src/data/types/entities.ts:683

terms​

• Optional terms: Record<string, TermEntity[]>

Defined in​

packages/core/src/data/types/entities.ts:687

title​

• title: string

The title for the object.

Inherited from​

SearchObjectEntity.title

Defined in​

packages/core/src/data/types/entities.ts:668

type​

• type: "post" | "term" | "post-format"

Type of Search for the object.

Inherited from​

SearchObjectEntity.type

Defined in​

packages/core/src/data/types/entities.ts:673

url​

• url: string

URL to the object.

Inherited from​

SearchObjectEntity.url

Defined in​

packages/core/src/data/types/entities.ts:663

yoast_head​

• Optional yoast_head: null | string

Inherited from​

SearchObjectEntity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:14

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Inherited from​

SearchObjectEntity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:13

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.PostTypeEntity/index.html b/api/interfaces/headstartwp_core.PostTypeEntity/index.html index 93fcc0007..f65dfbb56 100644 --- a/api/interfaces/headstartwp_core.PostTypeEntity/index.html +++ b/api/interfaces/headstartwp_core.PostTypeEntity/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: PostTypeEntity

@headstartwp/core.PostTypeEntity

Base interface for all post type entities.

Interfaces that extends from this one are:

Hierarchy​

Properties​

_embedded​

• _embedded: Object

Type declaration​

NameType
authorAuthorEntity[]
wp:termTermEntity[][]

Defined in​

packages/core/src/data/types/entities.ts:98

author​

• Optional author: AuthorEntity[]

Defined in​

packages/core/src/data/types/entities.ts:94

comment_status​

• Optional comment_status: "open" | "closed"

Whether or not comments are open on the object.

Defined in​

packages/core/src/data/types/entities.ts:106

date​

• date: string

The date the object was published, in the site's timezone.

Defined in​

packages/core/src/data/types/entities.ts:42

date_gmt​

• date_gmt: string

The date the object was published, as GMT.

Defined in​

packages/core/src/data/types/entities.ts:47

guid​

• guid: Rendered

The globally unique identifier for the object.

Defined in​

packages/core/src/data/types/entities.ts:52

id​

• id: number

Unique identifier for the object.

Defined in​

packages/core/src/data/types/entities.ts:67

• link: string

URL to the object.

Defined in​

packages/core/src/data/types/entities.ts:72

modified​

• modified: string

The date the object was last modified, in the site's timezone.

Defined in​

packages/core/src/data/types/entities.ts:57

modified_gmt​

• modified_gmt: string

The date the object was last modified, as GMT.

Defined in​

packages/core/src/data/types/entities.ts:62

ping_status​

• ping_status: "open" | "closed"

Whether or not the object can be pinged.

Defined in​

packages/core/src/data/types/entities.ts:111

slug​

• slug: string

An alphanumeric identifier for the object unique to its type.

Defined in​

packages/core/src/data/types/entities.ts:77

status​

• status: "publish" | "future" | "draft" | "pending" | "private"

A named status for the object.

Defined in​

packages/core/src/data/types/entities.ts:82

terms​

• Optional terms: Record<string, TermEntity[]>

Defined in​

packages/core/src/data/types/entities.ts:96

title​

• title: Rendered

The title for the object.

Defined in​

packages/core/src/data/types/entities.ts:92

type​

• type: string

Type of Post for the object.

Defined in​

packages/core/src/data/types/entities.ts:87

yoast_head​

• Optional yoast_head: null | string

Overrides​

Entity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:114

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Overrides​

Entity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:113

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: PostTypeEntity

@headstartwp/core.PostTypeEntity

Base interface for all post type entities.

Interfaces that extends from this one are:

Hierarchy​

Properties​

_embedded​

• _embedded: Object

Type declaration​

NameType
authorAuthorEntity[]
wp:termTermEntity[][]

Defined in​

packages/core/src/data/types/entities.ts:98

author​

• Optional author: AuthorEntity[]

Defined in​

packages/core/src/data/types/entities.ts:94

comment_status​

• Optional comment_status: "open" | "closed"

Whether or not comments are open on the object.

Defined in​

packages/core/src/data/types/entities.ts:106

date​

• date: string

The date the object was published, in the site's timezone.

Defined in​

packages/core/src/data/types/entities.ts:42

date_gmt​

• date_gmt: string

The date the object was published, as GMT.

Defined in​

packages/core/src/data/types/entities.ts:47

guid​

• guid: Rendered

The globally unique identifier for the object.

Defined in​

packages/core/src/data/types/entities.ts:52

id​

• id: number

Unique identifier for the object.

Defined in​

packages/core/src/data/types/entities.ts:67

• link: string

URL to the object.

Defined in​

packages/core/src/data/types/entities.ts:72

modified​

• modified: string

The date the object was last modified, in the site's timezone.

Defined in​

packages/core/src/data/types/entities.ts:57

modified_gmt​

• modified_gmt: string

The date the object was last modified, as GMT.

Defined in​

packages/core/src/data/types/entities.ts:62

ping_status​

• ping_status: "open" | "closed"

Whether or not the object can be pinged.

Defined in​

packages/core/src/data/types/entities.ts:111

slug​

• slug: string

An alphanumeric identifier for the object unique to its type.

Defined in​

packages/core/src/data/types/entities.ts:77

status​

• status: "publish" | "future" | "draft" | "pending" | "private"

A named status for the object.

Defined in​

packages/core/src/data/types/entities.ts:82

terms​

• Optional terms: Record<string, TermEntity[]>

Defined in​

packages/core/src/data/types/entities.ts:96

title​

• title: Rendered

The title for the object.

Defined in​

packages/core/src/data/types/entities.ts:92

type​

• type: string

Type of Post for the object.

Defined in​

packages/core/src/data/types/entities.ts:87

yoast_head​

• Optional yoast_head: null | string

Overrides​

Entity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:114

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Overrides​

Entity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:113

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.PostsArchiveParams/index.html b/api/interfaces/headstartwp_core.PostsArchiveParams/index.html index d86e363c6..f5f44005a 100644 --- a/api/interfaces/headstartwp_core.PostsArchiveParams/index.html +++ b/api/interfaces/headstartwp_core.PostsArchiveParams/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: PostsArchiveParams

@headstartwp/core.PostsArchiveParams

The EndpointParams supported by the PostsArchiveFetchStrategy

Hierarchy​

Properties​

_embed​

• Optional _embed: boolean

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data

Inherited from​

EndpointParams._embed

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:17

_fields​

• Optional _fields: string[]

The _fields parameter is used to return only the specified fields in the response

Inherited from​

EndpointParams._fields

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:22

author​

• Optional author: string | number | number[]

Limit result set to posts assigned to specific authors.

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:83

author_exclude​

• Optional author_exclude: number | number[]

Ensure result set excludes posts assigned to specific authors.

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:88

categories​

• Optional categories: string | number | string[] | number[]

Limit result set to all items that have the specified term assigned in the categories taxonomy.

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:156

categories_exclude​

• Optional categories_exclude: number | number[]

Limit result set to all items except those that have the specified term assigned in the categories taxonomy.

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:161

category​

• Optional category: string | number | number[]

If set will filter results by the specified category name

It supports both a category id and category slug

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:44

day​

• Optional day: string

If set will filter results by the specified day

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:66

exclude​

• Optional exclude: number[]

Ensure result set excludes specific IDs.

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:93

include​

• Optional include: number[]

Limit result set to specific IDs.

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:98

lang​

• Optional lang: string

The polylang ?lang parameter.

This is only used if the polylang integration is enabled

Inherited from​

EndpointParams.lang

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:29

matchArchivePath​

• Optional matchArchivePath: boolean

Overrides the value set in CustomTaxonomy#matchArchivePath

Default

false

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:190

month​

• Optional month: string

If set will filter results by the specified month

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:61

offset​

• Optional offset: number

Offset the result set by a specific number of items.

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:103

order​

• Optional order: "asc" | "desc"

Order sort attribute ascending or descending.

Default

'desc'

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:110

orderby​

• Optional orderby: "slug" | "date" | "modified" | "id" | "title" | "author" | "parent" | "include" | "relevance" | "include_slugs"

Sort collection by object attribute.

Default

'date'

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:129

page​

• Optional page: number

Current page of the collection.

Default

1

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:37

per_page​

• Optional per_page: number

Maximum number of items to be returned in result set.

Default

10

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:73

postType​

• Optional postType: string

The post type to query for.

Default

'post'

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:117

• Optional search: string

Limit results to those matching a string.

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:78

slug​

• Optional slug: string | string[]

Limit result set to posts with one or more specific slugs.

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:122

status​

• Optional status: string | string[]

Limit result set to posts assigned one or more statuses.

Default

'publish'

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:146

sticky​

• Optional sticky: boolean

Limit result set to items that are sticky.

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:183

tag​

• Optional tag: string | number

If set will filter results by the specified tag name

It supports both a category id and category slug

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:51

tags​

• Optional tags: string | number | string[] | number[]

Limit result set to all items that have the specified term assigned in the tags taxonomy.

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:173

tags_exclude​

• Optional tags_exclude: number | number[]

Limit result set to all items except those that have the specified term assigned in the tags taxonomy.

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:178

tax_relation​

• Optional tax_relation: "AND" | "OR"

Limit result set based on relationship between multiple taxonomies.

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:151

taxonomy​

• Optional taxonomy: string

Limit results to a specific taxonomy and expects the actual term slug to come from the url]

If you only specify the taxonomy, the term slug will be assumed to be the first segment of the path

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:168

year​

• Optional year: string

If set will filter results by the specified year

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:56

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: PostsArchiveParams

@headstartwp/core.PostsArchiveParams

The EndpointParams supported by the PostsArchiveFetchStrategy

Hierarchy​

Properties​

_embed​

• Optional _embed: boolean

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data

Inherited from​

EndpointParams._embed

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:17

_fields​

• Optional _fields: string[]

The _fields parameter is used to return only the specified fields in the response

Inherited from​

EndpointParams._fields

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:22

author​

• Optional author: string | number | number[]

Limit result set to posts assigned to specific authors.

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:83

author_exclude​

• Optional author_exclude: number | number[]

Ensure result set excludes posts assigned to specific authors.

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:88

categories​

• Optional categories: string | number | string[] | number[]

Limit result set to all items that have the specified term assigned in the categories taxonomy.

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:156

categories_exclude​

• Optional categories_exclude: number | number[]

Limit result set to all items except those that have the specified term assigned in the categories taxonomy.

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:161

category​

• Optional category: string | number | number[]

If set will filter results by the specified category name

It supports both a category id and category slug

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:44

day​

• Optional day: string

If set will filter results by the specified day

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:66

exclude​

• Optional exclude: number[]

Ensure result set excludes specific IDs.

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:93

include​

• Optional include: number[]

Limit result set to specific IDs.

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:98

lang​

• Optional lang: string

The polylang ?lang parameter.

This is only used if the polylang integration is enabled

Inherited from​

EndpointParams.lang

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:29

matchArchivePath​

• Optional matchArchivePath: boolean

Overrides the value set in CustomTaxonomy#matchArchivePath

Default

false

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:190

month​

• Optional month: string

If set will filter results by the specified month

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:61

offset​

• Optional offset: number

Offset the result set by a specific number of items.

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:103

order​

• Optional order: "asc" | "desc"

Order sort attribute ascending or descending.

Default

'desc'

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:110

orderby​

• Optional orderby: "slug" | "date" | "modified" | "id" | "title" | "author" | "parent" | "include" | "relevance" | "include_slugs"

Sort collection by object attribute.

Default

'date'

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:129

page​

• Optional page: number

Current page of the collection.

Default

1

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:37

per_page​

• Optional per_page: number

Maximum number of items to be returned in result set.

Default

10

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:73

postType​

• Optional postType: string

The post type to query for.

Default

'post'

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:117

• Optional search: string

Limit results to those matching a string.

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:78

slug​

• Optional slug: string | string[]

Limit result set to posts with one or more specific slugs.

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:122

status​

• Optional status: string | string[]

Limit result set to posts assigned one or more statuses.

Default

'publish'

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:146

sticky​

• Optional sticky: boolean

Limit result set to items that are sticky.

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:183

tag​

• Optional tag: string | number

If set will filter results by the specified tag name

It supports both a category id and category slug

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:51

tags​

• Optional tags: string | number | string[] | number[]

Limit result set to all items that have the specified term assigned in the tags taxonomy.

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:173

tags_exclude​

• Optional tags_exclude: number | number[]

Limit result set to all items except those that have the specified term assigned in the tags taxonomy.

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:178

tax_relation​

• Optional tax_relation: "AND" | "OR"

Limit result set based on relationship between multiple taxonomies.

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:151

taxonomy​

• Optional taxonomy: string

Limit results to a specific taxonomy and expects the actual term slug to come from the url]

If you only specify the taxonomy, the term slug will be assumed to be the first segment of the path

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:168

year​

• Optional year: string

If set will filter results by the specified year

Defined in​

packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:56

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.Rendered/index.html b/api/interfaces/headstartwp_core.Rendered/index.html index 50a2069ec..24910d61b 100644 --- a/api/interfaces/headstartwp_core.Rendered/index.html +++ b/api/interfaces/headstartwp_core.Rendered/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content
Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content
Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.RevisionEntity/index.html b/api/interfaces/headstartwp_core.RevisionEntity/index.html index e5ce2987a..a68e4d0d7 100644 --- a/api/interfaces/headstartwp_core.RevisionEntity/index.html +++ b/api/interfaces/headstartwp_core.RevisionEntity/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: RevisionEntity

@headstartwp/core.RevisionEntity

Interface for entities from the /wp/v2/posts/1/revisions endpoint.

Hierarchy​

Properties​

_embedded​

• _embedded: Object

Type declaration​

NameType
authorAuthorEntity[]
wp:termTermEntity[][]

Inherited from​

PostTypeEntity._embedded

Defined in​

packages/core/src/data/types/entities.ts:98

author​

• Optional author: AuthorEntity[]

Inherited from​

PostTypeEntity.author

Defined in​

packages/core/src/data/types/entities.ts:94

comment_status​

• Optional comment_status: "open" | "closed"

Whether or not comments are open on the object.

Inherited from​

PostTypeEntity.comment_status

Defined in​

packages/core/src/data/types/entities.ts:106

content​

• Optional content: Rendered

The content for the object.

Defined in​

packages/core/src/data/types/entities.ts:189

date​

• date: string

The date the object was published, in the site's timezone.

Inherited from​

PostTypeEntity.date

Defined in​

packages/core/src/data/types/entities.ts:42

date_gmt​

• date_gmt: string

The date the object was published, as GMT.

Inherited from​

PostTypeEntity.date_gmt

Defined in​

packages/core/src/data/types/entities.ts:47

excerpt​

• Optional excerpt: Rendered

The excerpt for the object.

Defined in​

packages/core/src/data/types/entities.ts:194

guid​

• guid: Rendered

The globally unique identifier for the object.

Inherited from​

PostTypeEntity.guid

Defined in​

packages/core/src/data/types/entities.ts:52

id​

• id: number

Unique identifier for the object.

Inherited from​

PostTypeEntity.id

Defined in​

packages/core/src/data/types/entities.ts:67

• link: string

URL to the object.

Inherited from​

PostTypeEntity.link

Defined in​

packages/core/src/data/types/entities.ts:72

modified​

• modified: string

The date the object was last modified, in the site's timezone.

Inherited from​

PostTypeEntity.modified

Defined in​

packages/core/src/data/types/entities.ts:57

modified_gmt​

• modified_gmt: string

The date the object was last modified, as GMT.

Inherited from​

PostTypeEntity.modified_gmt

Defined in​

packages/core/src/data/types/entities.ts:62

parent​

• Optional parent: number

The ID for the parent of the object.

Defined in​

packages/core/src/data/types/entities.ts:184

ping_status​

• ping_status: "open" | "closed"

Whether or not the object can be pinged.

Inherited from​

PostTypeEntity.ping_status

Defined in​

packages/core/src/data/types/entities.ts:111

slug​

• slug: string

An alphanumeric identifier for the object unique to its type.

Inherited from​

PostTypeEntity.slug

Defined in​

packages/core/src/data/types/entities.ts:77

status​

• status: "publish" | "future" | "draft" | "pending" | "private"

A named status for the object.

Inherited from​

PostTypeEntity.status

Defined in​

packages/core/src/data/types/entities.ts:82

terms​

• Optional terms: Record<string, TermEntity[]>

Inherited from​

PostTypeEntity.terms

Defined in​

packages/core/src/data/types/entities.ts:96

title​

• title: Rendered

The title for the object.

Inherited from​

PostTypeEntity.title

Defined in​

packages/core/src/data/types/entities.ts:92

type​

• type: string

Type of Post for the object.

Inherited from​

PostTypeEntity.type

Defined in​

packages/core/src/data/types/entities.ts:87

yoast_head​

• Optional yoast_head: null | string

Inherited from​

PostTypeEntity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:114

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Inherited from​

PostTypeEntity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:113

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: RevisionEntity

@headstartwp/core.RevisionEntity

Interface for entities from the /wp/v2/posts/1/revisions endpoint.

Hierarchy​

Properties​

_embedded​

• _embedded: Object

Type declaration​

NameType
authorAuthorEntity[]
wp:termTermEntity[][]

Inherited from​

PostTypeEntity._embedded

Defined in​

packages/core/src/data/types/entities.ts:98

author​

• Optional author: AuthorEntity[]

Inherited from​

PostTypeEntity.author

Defined in​

packages/core/src/data/types/entities.ts:94

comment_status​

• Optional comment_status: "open" | "closed"

Whether or not comments are open on the object.

Inherited from​

PostTypeEntity.comment_status

Defined in​

packages/core/src/data/types/entities.ts:106

content​

• Optional content: Rendered

The content for the object.

Defined in​

packages/core/src/data/types/entities.ts:189

date​

• date: string

The date the object was published, in the site's timezone.

Inherited from​

PostTypeEntity.date

Defined in​

packages/core/src/data/types/entities.ts:42

date_gmt​

• date_gmt: string

The date the object was published, as GMT.

Inherited from​

PostTypeEntity.date_gmt

Defined in​

packages/core/src/data/types/entities.ts:47

excerpt​

• Optional excerpt: Rendered

The excerpt for the object.

Defined in​

packages/core/src/data/types/entities.ts:194

guid​

• guid: Rendered

The globally unique identifier for the object.

Inherited from​

PostTypeEntity.guid

Defined in​

packages/core/src/data/types/entities.ts:52

id​

• id: number

Unique identifier for the object.

Inherited from​

PostTypeEntity.id

Defined in​

packages/core/src/data/types/entities.ts:67

• link: string

URL to the object.

Inherited from​

PostTypeEntity.link

Defined in​

packages/core/src/data/types/entities.ts:72

modified​

• modified: string

The date the object was last modified, in the site's timezone.

Inherited from​

PostTypeEntity.modified

Defined in​

packages/core/src/data/types/entities.ts:57

modified_gmt​

• modified_gmt: string

The date the object was last modified, as GMT.

Inherited from​

PostTypeEntity.modified_gmt

Defined in​

packages/core/src/data/types/entities.ts:62

parent​

• Optional parent: number

The ID for the parent of the object.

Defined in​

packages/core/src/data/types/entities.ts:184

ping_status​

• ping_status: "open" | "closed"

Whether or not the object can be pinged.

Inherited from​

PostTypeEntity.ping_status

Defined in​

packages/core/src/data/types/entities.ts:111

slug​

• slug: string

An alphanumeric identifier for the object unique to its type.

Inherited from​

PostTypeEntity.slug

Defined in​

packages/core/src/data/types/entities.ts:77

status​

• status: "publish" | "future" | "draft" | "pending" | "private"

A named status for the object.

Inherited from​

PostTypeEntity.status

Defined in​

packages/core/src/data/types/entities.ts:82

terms​

• Optional terms: Record<string, TermEntity[]>

Inherited from​

PostTypeEntity.terms

Defined in​

packages/core/src/data/types/entities.ts:96

title​

• title: Rendered

The title for the object.

Inherited from​

PostTypeEntity.title

Defined in​

packages/core/src/data/types/entities.ts:92

type​

• type: string

Type of Post for the object.

Inherited from​

PostTypeEntity.type

Defined in​

packages/core/src/data/types/entities.ts:87

yoast_head​

• Optional yoast_head: null | string

Inherited from​

PostTypeEntity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:114

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Inherited from​

PostTypeEntity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:113

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.SearchEntity/index.html b/api/interfaces/headstartwp_core.SearchEntity/index.html index 296d1894a..433fdd4af 100644 --- a/api/interfaces/headstartwp_core.SearchEntity/index.html +++ b/api/interfaces/headstartwp_core.SearchEntity/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: SearchEntity

@headstartwp/core.SearchEntity

Interface for entities from the /wp/v2/search endpoint.

Hierarchy​

Properties​

searchedValue​

• searchedValue: string

Defined in​

packages/core/src/data/types/entities.ts:634

subtype​

• subtype: string | string[]

Subtype of Search for the object.

Defined in​

packages/core/src/data/types/entities.ts:644

type​

• type: string

Type of Search for the object.

Defined in​

packages/core/src/data/types/entities.ts:639

yoast_head​

• Optional yoast_head: null | string

Inherited from​

Entity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:14

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Inherited from​

Entity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:13

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: SearchEntity

@headstartwp/core.SearchEntity

Interface for entities from the /wp/v2/search endpoint.

Hierarchy​

Properties​

searchedValue​

• searchedValue: string

Defined in​

packages/core/src/data/types/entities.ts:634

subtype​

• subtype: string | string[]

Subtype of Search for the object.

Defined in​

packages/core/src/data/types/entities.ts:644

type​

• type: string

Type of Search for the object.

Defined in​

packages/core/src/data/types/entities.ts:639

yoast_head​

• Optional yoast_head: null | string

Inherited from​

Entity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:14

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Inherited from​

Entity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:13

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.SearchObjectEntity/index.html b/api/interfaces/headstartwp_core.SearchObjectEntity/index.html index 5b4ccf63a..e2e214e64 100644 --- a/api/interfaces/headstartwp_core.SearchObjectEntity/index.html +++ b/api/interfaces/headstartwp_core.SearchObjectEntity/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: SearchObjectEntity

@headstartwp/core.SearchObjectEntity

Interface for search object entities from the /wp/v2/search endpoint.

Interfaces that extends from this one are:

Hierarchy​

Properties​

id​

• id: number

Unique identifier for the object.

Defined in​

packages/core/src/data/types/entities.ts:658

title​

• title: string

The title for the object.

Defined in​

packages/core/src/data/types/entities.ts:668

type​

• type: "post" | "term" | "post-format"

Type of Search for the object.

Defined in​

packages/core/src/data/types/entities.ts:673

url​

• url: string

URL to the object.

Defined in​

packages/core/src/data/types/entities.ts:663

yoast_head​

• Optional yoast_head: null | string

Inherited from​

Entity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:14

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Inherited from​

Entity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:13

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: SearchObjectEntity

@headstartwp/core.SearchObjectEntity

Interface for search object entities from the /wp/v2/search endpoint.

Interfaces that extends from this one are:

Hierarchy​

Properties​

id​

• id: number

Unique identifier for the object.

Defined in​

packages/core/src/data/types/entities.ts:658

title​

• title: string

The title for the object.

Defined in​

packages/core/src/data/types/entities.ts:668

type​

• type: "post" | "term" | "post-format"

Type of Search for the object.

Defined in​

packages/core/src/data/types/entities.ts:673

url​

• url: string

URL to the object.

Defined in​

packages/core/src/data/types/entities.ts:663

yoast_head​

• Optional yoast_head: null | string

Inherited from​

Entity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:14

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Inherited from​

Entity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:13

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.SearchParams/index.html b/api/interfaces/headstartwp_core.SearchParams/index.html index 2d438ab5c..672d9d909 100644 --- a/api/interfaces/headstartwp_core.SearchParams/index.html +++ b/api/interfaces/headstartwp_core.SearchParams/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: SearchParams

@headstartwp/core.SearchParams

The EndpointParams supported by the SearchNativeFetchStrategy

Hierarchy​

Properties​

_embed​

• Optional _embed: boolean

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data

Inherited from​

EndpointParams._embed

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:17

_fields​

• Optional _fields: string[]

The _fields parameter is used to return only the specified fields in the response

Inherited from​

EndpointParams._fields

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:22

exclude​

• Optional exclude: number[]

Ensure result set excludes specific IDs.

Defined in​

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:47

include​

• Optional include: number[]

Limit result set to specific IDs.

Defined in​

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:52

lang​

• Optional lang: string

The polylang ?lang parameter.

This is only used if the polylang integration is enabled

Inherited from​

EndpointParams.lang

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:29

page​

• Optional page: number

Current page of the collection.

Default

1

Defined in​

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:18

per_page​

• Optional per_page: number

Maximum number of items to be returned in result set.

Default

10

Defined in​

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:25

• Optional search: string

Limit results to those matching a string.

Defined in​

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:30

subtype​

• Optional subtype: string | string[]

Limit results to items of one or more object subtypes.

Defined in​

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:42

type​

• Optional type: "post" | "term" | "post-format"

Limit results to items of an object type.

Default

'post'

Defined in​

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:37

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: SearchParams

@headstartwp/core.SearchParams

The EndpointParams supported by the SearchNativeFetchStrategy

Hierarchy​

Properties​

_embed​

• Optional _embed: boolean

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data

Inherited from​

EndpointParams._embed

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:17

_fields​

• Optional _fields: string[]

The _fields parameter is used to return only the specified fields in the response

Inherited from​

EndpointParams._fields

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:22

exclude​

• Optional exclude: number[]

Ensure result set excludes specific IDs.

Defined in​

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:47

include​

• Optional include: number[]

Limit result set to specific IDs.

Defined in​

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:52

lang​

• Optional lang: string

The polylang ?lang parameter.

This is only used if the polylang integration is enabled

Inherited from​

EndpointParams.lang

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:29

page​

• Optional page: number

Current page of the collection.

Default

1

Defined in​

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:18

per_page​

• Optional per_page: number

Maximum number of items to be returned in result set.

Default

10

Defined in​

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:25

• Optional search: string

Limit results to those matching a string.

Defined in​

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:30

subtype​

• Optional subtype: string | string[]

Limit results to items of one or more object subtypes.

Defined in​

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:42

type​

• Optional type: "post" | "term" | "post-format"

Limit results to items of an object type.

Default

'post'

Defined in​

packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:37

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.TaxonomyArchiveParams/index.html b/api/interfaces/headstartwp_core.TaxonomyArchiveParams/index.html index 63f845533..84850e099 100644 --- a/api/interfaces/headstartwp_core.TaxonomyArchiveParams/index.html +++ b/api/interfaces/headstartwp_core.TaxonomyArchiveParams/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: TaxonomyArchiveParams

@headstartwp/core.TaxonomyArchiveParams

The endpoint params supported by TaxonomyTermsStrategy

Hierarchy​

Properties​

_embed​

• Optional _embed: boolean

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data

Inherited from​

EndpointParams._embed

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:17

_fields​

• Optional _fields: string[]

The _fields parameter is used to return only the specified fields in the response

Inherited from​

EndpointParams._fields

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:22

exclude​

• Optional exclude: number | number[]

Ensure result set excludes specific IDs.

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:49

hide_empty​

• Optional hide_empty: string

Whether to hide terms not assigned to any posts.

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:76

include​

• Optional include: number | number[]

Limit result set to specific IDs.

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:44

lang​

• Optional lang: string

The polylang ?lang parameter.

This is only used if the polylang integration is enabled

Inherited from​

EndpointParams.lang

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:29

order​

• Optional order: "asc" | "desc"

Order sort attribute ascending or descending.

Default

'asc'

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:56

orderby​

• Optional orderby: "slug" | "id" | "description" | "name" | "count" | "include" | "include_slugs" | "term_group"

Sort collection by term attribute.

Default

'name'

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:63

page​

• Optional page: string

Current page of the collection.

Default

1

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:27

parent​

• Optional parent: number

Limit result set to terms assigned to a specific parent.

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:81

per_page​

• Optional per_page: string

Maximum number of items to be returned in result set.

Default

10

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:34

post​

• Optional post: number

Limit result set to terms assigned to a specific post.

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:86

• Optional search: string

Limit results to those matching a string

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:39

slug​

• Optional slug: string | string[]

Limit result set to terms with one or more specific slugs.

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:91

taxonomy​

• Optional taxonomy: string

The taxonomy the terms are to be fetched from.

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:20

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: TaxonomyArchiveParams

@headstartwp/core.TaxonomyArchiveParams

The endpoint params supported by TaxonomyTermsStrategy

Hierarchy​

Properties​

_embed​

• Optional _embed: boolean

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data

Inherited from​

EndpointParams._embed

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:17

_fields​

• Optional _fields: string[]

The _fields parameter is used to return only the specified fields in the response

Inherited from​

EndpointParams._fields

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:22

exclude​

• Optional exclude: number | number[]

Ensure result set excludes specific IDs.

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:49

hide_empty​

• Optional hide_empty: string

Whether to hide terms not assigned to any posts.

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:76

include​

• Optional include: number | number[]

Limit result set to specific IDs.

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:44

lang​

• Optional lang: string

The polylang ?lang parameter.

This is only used if the polylang integration is enabled

Inherited from​

EndpointParams.lang

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:29

order​

• Optional order: "asc" | "desc"

Order sort attribute ascending or descending.

Default

'asc'

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:56

orderby​

• Optional orderby: "slug" | "id" | "description" | "name" | "count" | "include" | "include_slugs" | "term_group"

Sort collection by term attribute.

Default

'name'

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:63

page​

• Optional page: string

Current page of the collection.

Default

1

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:27

parent​

• Optional parent: number

Limit result set to terms assigned to a specific parent.

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:81

per_page​

• Optional per_page: string

Maximum number of items to be returned in result set.

Default

10

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:34

post​

• Optional post: number

Limit result set to terms assigned to a specific post.

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:86

• Optional search: string

Limit results to those matching a string

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:39

slug​

• Optional slug: string | string[]

Limit result set to terms with one or more specific slugs.

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:91

taxonomy​

• Optional taxonomy: string

The taxonomy the terms are to be fetched from.

Defined in​

packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:20

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.TaxonomyEntity/index.html b/api/interfaces/headstartwp_core.TaxonomyEntity/index.html index 9a1caef37..a31520fbb 100644 --- a/api/interfaces/headstartwp_core.TaxonomyEntity/index.html +++ b/api/interfaces/headstartwp_core.TaxonomyEntity/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: TaxonomyEntity

@headstartwp/core.TaxonomyEntity

Interface for entities from the /wp/v2/taxonomy endpoint.

Hierarchy​

Properties​

description​

• description: string

A human-readable description of the taxonomy.

Defined in​

packages/core/src/data/types/entities.ts:397

hierarchical​

• hierarchical: boolean

Whether or not the taxonomy should have children.

Defined in​

packages/core/src/data/types/entities.ts:402

name​

• name: string

The title for the taxonomy.

Defined in​

packages/core/src/data/types/entities.ts:407

rest_base​

• rest_base: string

REST base route for the taxonomy.

Defined in​

packages/core/src/data/types/entities.ts:417

slug​

• slug: string

An alphanumeric identifier for the taxonomy.

Defined in​

packages/core/src/data/types/entities.ts:412

types​

• types: string[]

Types associated with the taxonomy.

Defined in​

packages/core/src/data/types/entities.ts:422

yoast_head​

• Optional yoast_head: null | string

Inherited from​

Entity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:14

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Inherited from​

Entity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:13

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: TaxonomyEntity

@headstartwp/core.TaxonomyEntity

Interface for entities from the /wp/v2/taxonomy endpoint.

Hierarchy​

Properties​

description​

• description: string

A human-readable description of the taxonomy.

Defined in​

packages/core/src/data/types/entities.ts:397

hierarchical​

• hierarchical: boolean

Whether or not the taxonomy should have children.

Defined in​

packages/core/src/data/types/entities.ts:402

name​

• name: string

The title for the taxonomy.

Defined in​

packages/core/src/data/types/entities.ts:407

rest_base​

• rest_base: string

REST base route for the taxonomy.

Defined in​

packages/core/src/data/types/entities.ts:417

slug​

• slug: string

An alphanumeric identifier for the taxonomy.

Defined in​

packages/core/src/data/types/entities.ts:412

types​

• types: string[]

Types associated with the taxonomy.

Defined in​

packages/core/src/data/types/entities.ts:422

yoast_head​

• Optional yoast_head: null | string

Inherited from​

Entity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:14

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Inherited from​

Entity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:13

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.TermEntity/index.html b/api/interfaces/headstartwp_core.TermEntity/index.html index 417cceb81..041bf17f2 100644 --- a/api/interfaces/headstartwp_core.TermEntity/index.html +++ b/api/interfaces/headstartwp_core.TermEntity/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: TermEntity

@headstartwp/core.TermEntity

Interface for entities that belong to a taxonomy.

For example:

  • entities from the /wp/v2/categories endpoint.
  • entities from the /wp/v2/tags endpoint.

Hierarchy​

Properties​

count​

• count: number

Number of published posts for the term.

Defined in​

packages/core/src/data/types/entities.ts:441

description​

• description: string

HTML description of the term.

Defined in​

packages/core/src/data/types/entities.ts:446

id​

• id: number

Unique identifier for the term.

Defined in​

packages/core/src/data/types/entities.ts:436

• link: string

URL of the term.

Defined in​

packages/core/src/data/types/entities.ts:451

meta​

• meta: Record<string, unknown>

Meta fields.

Defined in​

packages/core/src/data/types/entities.ts:476

name​

• name: string

HTML title for the term.

Defined in​

packages/core/src/data/types/entities.ts:456

parent​

• parent: number

The parent term ID.

Defined in​

packages/core/src/data/types/entities.ts:471

slug​

• slug: string

An alphanumeric identifier for the term unique to its type.

Defined in​

packages/core/src/data/types/entities.ts:461

taxonomy​

• taxonomy: string

Type attribution for the term.

Defined in​

packages/core/src/data/types/entities.ts:466

yoast_head​

• Optional yoast_head: null | string

Overrides​

Entity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:479

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Overrides​

Entity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:478

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: TermEntity

@headstartwp/core.TermEntity

Interface for entities that belong to a taxonomy.

For example:

  • entities from the /wp/v2/categories endpoint.
  • entities from the /wp/v2/tags endpoint.

Hierarchy​

Properties​

count​

• count: number

Number of published posts for the term.

Defined in​

packages/core/src/data/types/entities.ts:441

description​

• description: string

HTML description of the term.

Defined in​

packages/core/src/data/types/entities.ts:446

id​

• id: number

Unique identifier for the term.

Defined in​

packages/core/src/data/types/entities.ts:436

• link: string

URL of the term.

Defined in​

packages/core/src/data/types/entities.ts:451

meta​

• meta: Record<string, unknown>

Meta fields.

Defined in​

packages/core/src/data/types/entities.ts:476

name​

• name: string

HTML title for the term.

Defined in​

packages/core/src/data/types/entities.ts:456

parent​

• parent: number

The parent term ID.

Defined in​

packages/core/src/data/types/entities.ts:471

slug​

• slug: string

An alphanumeric identifier for the term unique to its type.

Defined in​

packages/core/src/data/types/entities.ts:461

taxonomy​

• taxonomy: string

Type attribution for the term.

Defined in​

packages/core/src/data/types/entities.ts:466

yoast_head​

• Optional yoast_head: null | string

Overrides​

Entity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:479

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Overrides​

Entity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:478

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.TermSearchEntity/index.html b/api/interfaces/headstartwp_core.TermSearchEntity/index.html index 113f85159..e0e2bab00 100644 --- a/api/interfaces/headstartwp_core.TermSearchEntity/index.html +++ b/api/interfaces/headstartwp_core.TermSearchEntity/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: TermSearchEntity

@headstartwp/core.TermSearchEntity

Interface for terms entities from the /wp/v2/search endpoint.

Hierarchy​

Properties​

_embedded​

• _embedded: Object

Type declaration​

NameType
selfTermEntity[]

Defined in​

packages/core/src/data/types/entities.ts:700

id​

• id: number

Unique identifier for the object.

Inherited from​

SearchObjectEntity.id

Defined in​

packages/core/src/data/types/entities.ts:658

title​

• title: string

The title for the object.

Inherited from​

SearchObjectEntity.title

Defined in​

packages/core/src/data/types/entities.ts:668

type​

• type: "post" | "term" | "post-format"

Type of Search for the object.

Inherited from​

SearchObjectEntity.type

Defined in​

packages/core/src/data/types/entities.ts:673

url​

• url: string

URL to the object.

Inherited from​

SearchObjectEntity.url

Defined in​

packages/core/src/data/types/entities.ts:663

yoast_head​

• Optional yoast_head: null | string

Inherited from​

SearchObjectEntity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:14

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Inherited from​

SearchObjectEntity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:13

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: TermSearchEntity

@headstartwp/core.TermSearchEntity

Interface for terms entities from the /wp/v2/search endpoint.

Hierarchy​

Properties​

_embedded​

• _embedded: Object

Type declaration​

NameType
selfTermEntity[]

Defined in​

packages/core/src/data/types/entities.ts:700

id​

• id: number

Unique identifier for the object.

Inherited from​

SearchObjectEntity.id

Defined in​

packages/core/src/data/types/entities.ts:658

title​

• title: string

The title for the object.

Inherited from​

SearchObjectEntity.title

Defined in​

packages/core/src/data/types/entities.ts:668

type​

• type: "post" | "term" | "post-format"

Type of Search for the object.

Inherited from​

SearchObjectEntity.type

Defined in​

packages/core/src/data/types/entities.ts:673

url​

• url: string

URL to the object.

Inherited from​

SearchObjectEntity.url

Defined in​

packages/core/src/data/types/entities.ts:663

yoast_head​

• Optional yoast_head: null | string

Inherited from​

SearchObjectEntity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:14

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Inherited from​

SearchObjectEntity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:13

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.TypeEntity/index.html b/api/interfaces/headstartwp_core.TypeEntity/index.html index b742ec69b..378245e21 100644 --- a/api/interfaces/headstartwp_core.TypeEntity/index.html +++ b/api/interfaces/headstartwp_core.TypeEntity/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: TypeEntity

@headstartwp/core.TypeEntity

Interface for entities from the /wp/v2/types endpoint.

Hierarchy​

Properties​

description​

• Optional description: string

A human-readable description of the post type.

Defined in​

packages/core/src/data/types/entities.ts:362

hierarchical​

• Optional hierarchical: boolean

Whether or not the post type should have children.

Defined in​

packages/core/src/data/types/entities.ts:367

name​

• Optional name: string

The title for the post type.

Defined in​

packages/core/src/data/types/entities.ts:372

rest_base​

• rest_base: string

REST base route for the post type.

Defined in​

packages/core/src/data/types/entities.ts:382

slug​

• Optional slug: string

An alphanumeric identifier for the post type.

Defined in​

packages/core/src/data/types/entities.ts:377

taxonomies​

• taxonomies: string[]

Taxonomies associated with post type.

Defined in​

packages/core/src/data/types/entities.ts:387

yoast_head​

• Optional yoast_head: null | string

Inherited from​

Entity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:14

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Inherited from​

Entity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:13

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: TypeEntity

@headstartwp/core.TypeEntity

Interface for entities from the /wp/v2/types endpoint.

Hierarchy​

Properties​

description​

• Optional description: string

A human-readable description of the post type.

Defined in​

packages/core/src/data/types/entities.ts:362

hierarchical​

• Optional hierarchical: boolean

Whether or not the post type should have children.

Defined in​

packages/core/src/data/types/entities.ts:367

name​

• Optional name: string

The title for the post type.

Defined in​

packages/core/src/data/types/entities.ts:372

rest_base​

• rest_base: string

REST base route for the post type.

Defined in​

packages/core/src/data/types/entities.ts:382

slug​

• Optional slug: string

An alphanumeric identifier for the post type.

Defined in​

packages/core/src/data/types/entities.ts:377

taxonomies​

• taxonomies: string[]

Taxonomies associated with post type.

Defined in​

packages/core/src/data/types/entities.ts:387

yoast_head​

• Optional yoast_head: null | string

Inherited from​

Entity.yoast_head

Defined in​

packages/core/src/data/types/entities.ts:14

yoast_head_json​

• Optional yoast_head_json: null | Record<string, any>

Inherited from​

Entity.yoast_head_json

Defined in​

packages/core/src/data/types/entities.ts:13

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.VerifyTokenParams/index.html b/api/interfaces/headstartwp_core.VerifyTokenParams/index.html index 808ec9ccd..5a1250143 100644 --- a/api/interfaces/headstartwp_core.VerifyTokenParams/index.html +++ b/api/interfaces/headstartwp_core.VerifyTokenParams/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: VerifyTokenParams

@headstartwp/core.VerifyTokenParams

The EndpointParams supported by the VerifyTokenFetchStrategy

Hierarchy​

Properties​

_embed​

• Optional _embed: boolean

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data

Inherited from​

EndpointParams._embed

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:17

_fields​

• Optional _fields: string[]

The _fields parameter is used to return only the specified fields in the response

Inherited from​

EndpointParams._fields

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:22

authToken​

• Optional authToken: string

Defined in​

packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:9

lang​

• Optional lang: string

The polylang ?lang parameter.

This is only used if the polylang integration is enabled

Inherited from​

EndpointParams.lang

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:29

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: VerifyTokenParams

@headstartwp/core.VerifyTokenParams

The EndpointParams supported by the VerifyTokenFetchStrategy

Hierarchy​

Properties​

_embed​

• Optional _embed: boolean

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data

Inherited from​

EndpointParams._embed

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:17

_fields​

• Optional _fields: string[]

The _fields parameter is used to return only the specified fields in the response

Inherited from​

EndpointParams._fields

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:22

authToken​

• Optional authToken: string

Defined in​

packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:9

lang​

• Optional lang: string

The polylang ?lang parameter.

This is only used if the polylang integration is enabled

Inherited from​

EndpointParams.lang

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:29

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.YoastSEOIntegration/index.html b/api/interfaces/headstartwp_core.YoastSEOIntegration/index.html index 44613f82b..ff2b3f32c 100644 --- a/api/interfaces/headstartwp_core.YoastSEOIntegration/index.html +++ b/api/interfaces/headstartwp_core.YoastSEOIntegration/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content
Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content
Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.AudioBlockProps/index.html b/api/interfaces/headstartwp_core.react.AudioBlockProps/index.html index a97dfc6e7..19b919373 100644 --- a/api/interfaces/headstartwp_core.react.AudioBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.AudioBlockProps/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: AudioBlockProps

@headstartwp/core.react.AudioBlockProps

The interface for components rendered by AudioBlock

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

autoplay​

• Optional autoplay: boolean

Whether the audio should be autoplayable

Defined in​

packages/core/src/react/blocks/AudioBlock.tsx:19

caption​

• Optional caption: string

Audio caption

Defined in​

packages/core/src/react/blocks/AudioBlock.tsx:24

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

loop​

• Optional loop: boolean

Whether the audio should be played in a loop

Defined in​

packages/core/src/react/blocks/AudioBlock.tsx:29

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

preload​

• Optional preload: string

Whether to preload the audio or not

Defined in​

packages/core/src/react/blocks/AudioBlock.tsx:34

src​

• src: string

The audio source URL.

Defined in​

packages/core/src/react/blocks/AudioBlock.tsx:14

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: AudioBlockProps

@headstartwp/core.react.AudioBlockProps

The interface for components rendered by AudioBlock

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

autoplay​

• Optional autoplay: boolean

Whether the audio should be autoplayable

Defined in​

packages/core/src/react/blocks/AudioBlock.tsx:19

caption​

• Optional caption: string

Audio caption

Defined in​

packages/core/src/react/blocks/AudioBlock.tsx:24

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

loop​

• Optional loop: boolean

Whether the audio should be played in a loop

Defined in​

packages/core/src/react/blocks/AudioBlock.tsx:29

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

preload​

• Optional preload: string

Whether to preload the audio or not

Defined in​

packages/core/src/react/blocks/AudioBlock.tsx:34

src​

• src: string

The audio source URL.

Defined in​

packages/core/src/react/blocks/AudioBlock.tsx:14

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.BlockAttributes/index.html b/api/interfaces/headstartwp_core.react.BlockAttributes/index.html index 10f1d3d8d..9bc2da5ea 100644 --- a/api/interfaces/headstartwp_core.react.BlockAttributes/index.html +++ b/api/interfaces/headstartwp_core.react.BlockAttributes/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: BlockAttributes

@headstartwp/core.react.BlockAttributes

Hierarchy​

Properties​

align​

• align: Align

Defined in​

packages/core/src/react/blocks/types.ts:95

backgroundColor​

• backgroundColor: string

Inherited from​

Colors.backgroundColor

Defined in​

packages/core/src/react/blocks/types.ts:6

backgroundColorSlug​

• backgroundColorSlug: string

Inherited from​

Colors.backgroundColorSlug

Defined in​

packages/core/src/react/blocks/types.ts:5

gradient​

• gradient: string

Inherited from​

Colors.gradient

Defined in​

packages/core/src/react/blocks/types.ts:8

gradientSlug​

• gradientSlug: string

Inherited from​

Colors.gradientSlug

Defined in​

packages/core/src/react/blocks/types.ts:7

linkColor​

• linkColor: string

Inherited from​

Colors.linkColor

Defined in​

packages/core/src/react/blocks/types.ts:12

linkColorSlug​

• linkColorSlug: string

Inherited from​

Colors.linkColorSlug

Defined in​

packages/core/src/react/blocks/types.ts:11

style​

• style: Partial<Style>

Defined in​

packages/core/src/react/blocks/types.ts:96

textColor​

• textColor: string

Inherited from​

Colors.textColor

Defined in​

packages/core/src/react/blocks/types.ts:10

textColorSlug​

• textColorSlug: string

Inherited from​

Colors.textColorSlug

Defined in​

packages/core/src/react/blocks/types.ts:9

typography​

• typography: Typography

Defined in​

packages/core/src/react/blocks/types.ts:98

width​

• width: string

Defined in​

packages/core/src/react/blocks/types.ts:97

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: BlockAttributes

@headstartwp/core.react.BlockAttributes

Hierarchy​

Properties​

align​

• align: Align

Defined in​

packages/core/src/react/blocks/types.ts:95

backgroundColor​

• backgroundColor: string

Inherited from​

Colors.backgroundColor

Defined in​

packages/core/src/react/blocks/types.ts:6

backgroundColorSlug​

• backgroundColorSlug: string

Inherited from​

Colors.backgroundColorSlug

Defined in​

packages/core/src/react/blocks/types.ts:5

gradient​

• gradient: string

Inherited from​

Colors.gradient

Defined in​

packages/core/src/react/blocks/types.ts:8

gradientSlug​

• gradientSlug: string

Inherited from​

Colors.gradientSlug

Defined in​

packages/core/src/react/blocks/types.ts:7

linkColor​

• linkColor: string

Inherited from​

Colors.linkColor

Defined in​

packages/core/src/react/blocks/types.ts:12

linkColorSlug​

• linkColorSlug: string

Inherited from​

Colors.linkColorSlug

Defined in​

packages/core/src/react/blocks/types.ts:11

style​

• style: Partial<Style>

Defined in​

packages/core/src/react/blocks/types.ts:96

textColor​

• textColor: string

Inherited from​

Colors.textColor

Defined in​

packages/core/src/react/blocks/types.ts:10

textColorSlug​

• textColorSlug: string

Inherited from​

Colors.textColorSlug

Defined in​

packages/core/src/react/blocks/types.ts:9

typography​

• typography: Typography

Defined in​

packages/core/src/react/blocks/types.ts:98

width​

• width: string

Defined in​

packages/core/src/react/blocks/types.ts:97

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.BlockProps/index.html b/api/interfaces/headstartwp_core.react.BlockProps/index.html index aaf38c468..f0bb6c485 100644 --- a/api/interfaces/headstartwp_core.react.BlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.BlockProps/index.html @@ -7,15 +7,15 @@ - - + +
-
Skip to main content

Interface: BlockProps

@headstartwp/core.react.BlockProps

The interface any children of BlocksRenderer must implement.

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

domNode​

• Optional domNode: Element

The actual domNode that was replaced with the react component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:46

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

test​

• Optional test: (domNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (domNode, site?): boolean

A test function receives a domNode and returns a boolean value indicating -whether that domNode should be replaced with the React component

Parameters​
NameType
domNodeElement
site?HeadlessConfig
Returns​

boolean

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:19

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: BlockProps

@headstartwp/core.react.BlockProps

The interface any children of BlocksRenderer must implement.

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

domNode​

• Optional domNode: Element

The actual domNode that was replaced with the react component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:46

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

test​

• Optional test: (domNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (domNode, site?): boolean

A test function receives a domNode and returns a boolean value indicating +whether that domNode should be replaced with the React component

Parameters​
NameType
domNodeElement
site?HeadlessConfig
Returns​

boolean

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:19

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.BlockRendererProps/index.html b/api/interfaces/headstartwp_core.react.BlockRendererProps/index.html index 69752a934..9f8a71239 100644 --- a/api/interfaces/headstartwp_core.react.BlockRendererProps/index.html +++ b/api/interfaces/headstartwp_core.react.BlockRendererProps/index.html @@ -7,14 +7,14 @@ - - + +
Skip to main content

Interface: BlockRendererProps

@headstartwp/core.react.BlockRendererProps

The type definition for the BlocksRenderer component.

Properties​

children​

• Optional children: ReactNode

The children components that must implements BlockProps. Failing to implement BlockProps -will issue a warning at runtime.

Passing children are not mandatory, if you do not pass them BlocksRenderer will simply sanitize the html markup.

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:110

html​

• html: string

The HTML string to be parsed.

<BlocksRenderer
        html="<div><p>hello world</p> div content</div>"
/>,

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:83

ksesAllowList​

• Optional ksesAllowList: IWhiteList

The allow list for the parser

<BlocksRenderer
        html="<div><p>hello world</p> div content</div>"
        ksesAllowList={{ div: [] }}
/>,

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:95

sanitizeFn​

• Optional sanitizeFn: (html: string, ksesAllowList?: IWhiteList) => string

Type declaration​

▸ (html, ksesAllowList?): string

A custom implementation of the sanitize function.

If none is provided it's going to default to wpKsesPost

Parameters​
NameType
htmlstring
ksesAllowList?IWhiteList
Returns​

string

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:102

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +will issue a warning at runtime.

Passing children are not mandatory, if you do not pass them BlocksRenderer will simply sanitize the html markup.

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:110

html​

• html: string

The HTML string to be parsed.

<BlocksRenderer
        html="<div><p>hello world</p> div content</div>"
/>,

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:83

ksesAllowList​

• Optional ksesAllowList: IWhiteList

The allow list for the parser

<BlocksRenderer
        html="<div><p>hello world</p> div content</div>"
        ksesAllowList={{ div: [] }}
/>,

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:95

sanitizeFn​

• Optional sanitizeFn: (html: string, ksesAllowList?: IWhiteList) => string

Type declaration​

▸ (html, ksesAllowList?): string

A custom implementation of the sanitize function.

If none is provided it's going to default to wpKsesPost

Parameters​
NameType
htmlstring
ksesAllowList?IWhiteList
Returns​

string

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:102

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.ButtonBlockProps/index.html b/api/interfaces/headstartwp_core.react.ButtonBlockProps/index.html index 8e5f5440b..2a75abfb1 100644 --- a/api/interfaces/headstartwp_core.react.ButtonBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.ButtonBlockProps/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: ButtonBlockProps

@headstartwp/core.react.ButtonBlockProps

The interface for components rendered by ButtonBlock

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

linkTarget​

• Optional linkTarget: string

The link target

Defined in​

packages/core/src/react/blocks/ButtonBlock.tsx:31

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

placeholder​

• Optional placeholder: string

The link placeholder text

Defined in​

packages/core/src/react/blocks/ButtonBlock.tsx:41

rel​

• Optional rel: string

The link rel

Defined in​

packages/core/src/react/blocks/ButtonBlock.tsx:36

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

text​

• Optional text: string

The button text

Defined in​

packages/core/src/react/blocks/ButtonBlock.tsx:26

title​

• Optional title: string

The title of the link

Defined in​

packages/core/src/react/blocks/ButtonBlock.tsx:21

url​

• Optional url: string

The button url

Defined in​

packages/core/src/react/blocks/ButtonBlock.tsx:16

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: ButtonBlockProps

@headstartwp/core.react.ButtonBlockProps

The interface for components rendered by ButtonBlock

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

linkTarget​

• Optional linkTarget: string

The link target

Defined in​

packages/core/src/react/blocks/ButtonBlock.tsx:31

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

placeholder​

• Optional placeholder: string

The link placeholder text

Defined in​

packages/core/src/react/blocks/ButtonBlock.tsx:41

rel​

• Optional rel: string

The link rel

Defined in​

packages/core/src/react/blocks/ButtonBlock.tsx:36

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

text​

• Optional text: string

The button text

Defined in​

packages/core/src/react/blocks/ButtonBlock.tsx:26

title​

• Optional title: string

The title of the link

Defined in​

packages/core/src/react/blocks/ButtonBlock.tsx:21

url​

• Optional url: string

The button url

Defined in​

packages/core/src/react/blocks/ButtonBlock.tsx:16

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.ButtonsBlockProps/index.html b/api/interfaces/headstartwp_core.react.ButtonsBlockProps/index.html index 993d6a0c9..8a4eb316c 100644 --- a/api/interfaces/headstartwp_core.react.ButtonsBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.ButtonsBlockProps/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: ButtonsBlockProps

@headstartwp/core.react.ButtonsBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: ButtonsBlockProps

@headstartwp/core.react.ButtonsBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.CodeBlockProps/index.html b/api/interfaces/headstartwp_core.react.CodeBlockProps/index.html index 8605dd630..68c07de24 100644 --- a/api/interfaces/headstartwp_core.react.CodeBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.CodeBlockProps/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: CodeBlockProps

@headstartwp/core.react.CodeBlockProps

The interface for components rendered by CodeBlock

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: CodeBlockProps

@headstartwp/core.react.CodeBlockProps

The interface for components rendered by CodeBlock

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.Colors/index.html b/api/interfaces/headstartwp_core.react.Colors/index.html index 1630ca37d..0a9dc78af 100644 --- a/api/interfaces/headstartwp_core.react.Colors/index.html +++ b/api/interfaces/headstartwp_core.react.Colors/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: Colors

@headstartwp/core.react.Colors

Hierarchy​

Properties​

backgroundColor​

• backgroundColor: string

Defined in​

packages/core/src/react/blocks/types.ts:6

backgroundColorSlug​

• backgroundColorSlug: string

Defined in​

packages/core/src/react/blocks/types.ts:5

gradient​

• gradient: string

Defined in​

packages/core/src/react/blocks/types.ts:8

gradientSlug​

• gradientSlug: string

Defined in​

packages/core/src/react/blocks/types.ts:7

linkColor​

• linkColor: string

Defined in​

packages/core/src/react/blocks/types.ts:12

linkColorSlug​

• linkColorSlug: string

Defined in​

packages/core/src/react/blocks/types.ts:11

textColor​

• textColor: string

Defined in​

packages/core/src/react/blocks/types.ts:10

textColorSlug​

• textColorSlug: string

Defined in​

packages/core/src/react/blocks/types.ts:9

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: Colors

@headstartwp/core.react.Colors

Hierarchy​

Properties​

backgroundColor​

• backgroundColor: string

Defined in​

packages/core/src/react/blocks/types.ts:6

backgroundColorSlug​

• backgroundColorSlug: string

Defined in​

packages/core/src/react/blocks/types.ts:5

gradient​

• gradient: string

Defined in​

packages/core/src/react/blocks/types.ts:8

gradientSlug​

• gradientSlug: string

Defined in​

packages/core/src/react/blocks/types.ts:7

linkColor​

• linkColor: string

Defined in​

packages/core/src/react/blocks/types.ts:12

linkColorSlug​

• linkColorSlug: string

Defined in​

packages/core/src/react/blocks/types.ts:11

textColor​

• textColor: string

Defined in​

packages/core/src/react/blocks/types.ts:10

textColorSlug​

• textColorSlug: string

Defined in​

packages/core/src/react/blocks/types.ts:9

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.ColumnBlockProps/index.html b/api/interfaces/headstartwp_core.react.ColumnBlockProps/index.html index 590665985..dd8c609cf 100644 --- a/api/interfaces/headstartwp_core.react.ColumnBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.ColumnBlockProps/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: ColumnBlockProps

@headstartwp/core.react.ColumnBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: ColumnBlockProps

@headstartwp/core.react.ColumnBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.ColumnsBlockProps/index.html b/api/interfaces/headstartwp_core.react.ColumnsBlockProps/index.html index 8397be707..53e989a4b 100644 --- a/api/interfaces/headstartwp_core.react.ColumnsBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.ColumnsBlockProps/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: ColumnsBlockProps

@headstartwp/core.react.ColumnsBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: ColumnsBlockProps

@headstartwp/core.react.ColumnsBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.CoverBlockProps/index.html b/api/interfaces/headstartwp_core.react.CoverBlockProps/index.html index 7a0fa228a..e35c98d4d 100644 --- a/api/interfaces/headstartwp_core.react.CoverBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.CoverBlockProps/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: CoverBlockProps

@headstartwp/core.react.CoverBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

dimRatio​

• dimRatio: number

Defined in​

packages/core/src/react/blocks/CoverBlock.tsx:12

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

focalPoint​

• Optional focalPoint: Object

Type declaration​

NameType
xstring | number
ystring | number

Defined in​

packages/core/src/react/blocks/CoverBlock.tsx:16

hasParallax​

• hasParallax: boolean

Defined in​

packages/core/src/react/blocks/CoverBlock.tsx:9

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

id​

• id: number

Defined in​

packages/core/src/react/blocks/CoverBlock.tsx:11

isDark​

• isDark: boolean

Defined in​

packages/core/src/react/blocks/CoverBlock.tsx:13

isRepeated​

• isRepeated: boolean

Defined in​

packages/core/src/react/blocks/CoverBlock.tsx:10

minHeight​

• minHeight: number

Defined in​

packages/core/src/react/blocks/CoverBlock.tsx:15

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

overlayColor​

• overlayColor: string

Defined in​

packages/core/src/react/blocks/CoverBlock.tsx:8

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

url​

• url: string

Defined in​

packages/core/src/react/blocks/CoverBlock.tsx:14

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: CoverBlockProps

@headstartwp/core.react.CoverBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

dimRatio​

• dimRatio: number

Defined in​

packages/core/src/react/blocks/CoverBlock.tsx:12

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

focalPoint​

• Optional focalPoint: Object

Type declaration​

NameType
xstring | number
ystring | number

Defined in​

packages/core/src/react/blocks/CoverBlock.tsx:16

hasParallax​

• hasParallax: boolean

Defined in​

packages/core/src/react/blocks/CoverBlock.tsx:9

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

id​

• id: number

Defined in​

packages/core/src/react/blocks/CoverBlock.tsx:11

isDark​

• isDark: boolean

Defined in​

packages/core/src/react/blocks/CoverBlock.tsx:13

isRepeated​

• isRepeated: boolean

Defined in​

packages/core/src/react/blocks/CoverBlock.tsx:10

minHeight​

• minHeight: number

Defined in​

packages/core/src/react/blocks/CoverBlock.tsx:15

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

overlayColor​

• overlayColor: string

Defined in​

packages/core/src/react/blocks/CoverBlock.tsx:8

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

url​

• url: string

Defined in​

packages/core/src/react/blocks/CoverBlock.tsx:14

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.FetchHookOptions/index.html b/api/interfaces/headstartwp_core.react.FetchHookOptions/index.html index 936b5507c..550940958 100644 --- a/api/interfaces/headstartwp_core.react.FetchHookOptions/index.html +++ b/api/interfaces/headstartwp_core.react.FetchHookOptions/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: FetchHookOptions<T>

@headstartwp/core.react.FetchHookOptions

Type parameters​

Name
T

Properties​

fetchStrategyOptions​

• Optional fetchStrategyOptions: Partial<FetchOptions>

Defined in​

packages/core/src/react/hooks/types.ts:12

shouldFetch​

• Optional shouldFetch: boolean

Defined in​

packages/core/src/react/hooks/types.ts:14

swr​

• Optional swr: Partial<PublicConfiguration<T, any, BareFetcher<any>>>

Defined in​

packages/core/src/react/hooks/types.ts:13

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: FetchHookOptions<T>

@headstartwp/core.react.FetchHookOptions

Type parameters​

Name
T

Properties​

fetchStrategyOptions​

• Optional fetchStrategyOptions: Partial<FetchOptions>

Defined in​

packages/core/src/react/hooks/types.ts:12

shouldFetch​

• Optional shouldFetch: boolean

Defined in​

packages/core/src/react/hooks/types.ts:14

swr​

• Optional swr: Partial<PublicConfiguration<T, any, BareFetcher<any>>>

Defined in​

packages/core/src/react/hooks/types.ts:13

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.FileBlockProps/index.html b/api/interfaces/headstartwp_core.react.FileBlockProps/index.html index a92440de8..9ebcd29aa 100644 --- a/api/interfaces/headstartwp_core.react.FileBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.FileBlockProps/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: FileBlockProps

@headstartwp/core.react.FileBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

href​

• Optional href: string

Defined in​

packages/core/src/react/blocks/FileBlock.tsx:8

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

id​

• Optional id: number

Defined in​

packages/core/src/react/blocks/FileBlock.tsx:7

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

showDownloadButton​

• showDownloadButton: boolean

Defined in​

packages/core/src/react/blocks/FileBlock.tsx:9

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: FileBlockProps

@headstartwp/core.react.FileBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

href​

• Optional href: string

Defined in​

packages/core/src/react/blocks/FileBlock.tsx:8

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

id​

• Optional id: number

Defined in​

packages/core/src/react/blocks/FileBlock.tsx:7

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

showDownloadButton​

• showDownloadButton: boolean

Defined in​

packages/core/src/react/blocks/FileBlock.tsx:9

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.GroupBlockProps/index.html b/api/interfaces/headstartwp_core.react.GroupBlockProps/index.html index 6459001f2..6a7edfd8a 100644 --- a/api/interfaces/headstartwp_core.react.GroupBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.GroupBlockProps/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: GroupBlockProps

@headstartwp/core.react.GroupBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

layout​

• Optional layout: Object

Type declaration​

NameType
allowOrientation?boolean
justifyContent?"center" | "left" | "right" | "space-between"
type?string

Defined in​

packages/core/src/react/blocks/GroupBlock.tsx:8

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

tagName​

• Optional tagName: string

Defined in​

packages/core/src/react/blocks/GroupBlock.tsx:7

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: GroupBlockProps

@headstartwp/core.react.GroupBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

layout​

• Optional layout: Object

Type declaration​

NameType
allowOrientation?boolean
justifyContent?"center" | "left" | "right" | "space-between"
type?string

Defined in​

packages/core/src/react/blocks/GroupBlock.tsx:8

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

tagName​

• Optional tagName: string

Defined in​

packages/core/src/react/blocks/GroupBlock.tsx:7

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.GutenbergBlockProps/index.html b/api/interfaces/headstartwp_core.react.GutenbergBlockProps/index.html index 9ace19991..f57b34708 100644 --- a/api/interfaces/headstartwp_core.react.GutenbergBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.GutenbergBlockProps/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content
Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content
Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.HeadingBlockProps/index.html b/api/interfaces/headstartwp_core.react.HeadingBlockProps/index.html index 04b6fb21d..ae21e4dc2 100644 --- a/api/interfaces/headstartwp_core.react.HeadingBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.HeadingBlockProps/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: HeadingBlockProps

@headstartwp/core.react.HeadingBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

level​

• level: number

Defined in​

packages/core/src/react/blocks/HeadingBlock.tsx:7

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: HeadingBlockProps

@headstartwp/core.react.HeadingBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

level​

• level: number

Defined in​

packages/core/src/react/blocks/HeadingBlock.tsx:7

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.HookResponse/index.html b/api/interfaces/headstartwp_core.react.HookResponse/index.html index 50bf671b9..8f61ebc31 100644 --- a/api/interfaces/headstartwp_core.react.HookResponse/index.html +++ b/api/interfaces/headstartwp_core.react.HookResponse/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: HookResponse

@headstartwp/core.react.HookResponse

Hierarchy​

Properties​

data​

• Optional data: Object

Defined in​

packages/core/src/react/hooks/types.ts:5

error​

• Optional error: string

Defined in​

packages/core/src/react/hooks/types.ts:6

isMainQuery​

• isMainQuery: boolean

Defined in​

packages/core/src/react/hooks/types.ts:8

loading​

• loading: boolean

Defined in​

packages/core/src/react/hooks/types.ts:7

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: HookResponse

@headstartwp/core.react.HookResponse

Hierarchy​

Properties​

data​

• Optional data: Object

Defined in​

packages/core/src/react/hooks/types.ts:5

error​

• Optional error: string

Defined in​

packages/core/src/react/hooks/types.ts:6

isMainQuery​

• isMainQuery: boolean

Defined in​

packages/core/src/react/hooks/types.ts:8

loading​

• loading: boolean

Defined in​

packages/core/src/react/hooks/types.ts:7

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.HtmlDecodeProps/index.html b/api/interfaces/headstartwp_core.react.HtmlDecodeProps/index.html index 2bc06eb21..5f2264f08 100644 --- a/api/interfaces/headstartwp_core.react.HtmlDecodeProps/index.html +++ b/api/interfaces/headstartwp_core.react.HtmlDecodeProps/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content
Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content
Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IAudioBlock/index.html b/api/interfaces/headstartwp_core.react.IAudioBlock/index.html index 3039ead6e..6c41ec746 100644 --- a/api/interfaces/headstartwp_core.react.IAudioBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IAudioBlock/index.html @@ -7,14 +7,14 @@ - - + +
-
Skip to main content

Interface: IAudioBlock

@headstartwp/core.react.IAudioBlock

The interface for the AudioBlock component.

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: AudioBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsAudioBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: IAudioBlock

@headstartwp/core.react.IAudioBlock

The interface for the AudioBlock component.

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: AudioBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsAudioBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IBlock/index.html b/api/interfaces/headstartwp_core.react.IBlock/index.html index e1684c99d..544922305 100644 --- a/api/interfaces/headstartwp_core.react.IBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IBlock/index.html @@ -7,14 +7,14 @@ - - + +
-
Skip to main content

Interface: IBlock<T>

@headstartwp/core.react.IBlock

The common interface for a block transform component

Type parameters​

NameType
Textends IBlockAttributes

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

Omit.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

Omit.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: T) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsT
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Overrides​

Omit.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

Omit.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

Omit.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

Omit.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: IBlock<T>

@headstartwp/core.react.IBlock

The common interface for a block transform component

Type parameters​

NameType
Textends IBlockAttributes

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

Omit.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

Omit.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: T) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsT
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Overrides​

Omit.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

Omit.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

Omit.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

Omit.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IBlockAttributes/index.html b/api/interfaces/headstartwp_core.react.IBlockAttributes/index.html index c37507a09..57d0b3ff8 100644 --- a/api/interfaces/headstartwp_core.react.IBlockAttributes/index.html +++ b/api/interfaces/headstartwp_core.react.IBlockAttributes/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: IBlockAttributes

@headstartwp/core.react.IBlockAttributes

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: IBlockAttributes

@headstartwp/core.react.IBlockAttributes

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IButtonBlock/index.html b/api/interfaces/headstartwp_core.react.IButtonBlock/index.html index bead26800..d089f9d61 100644 --- a/api/interfaces/headstartwp_core.react.IButtonBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IButtonBlock/index.html @@ -7,14 +7,14 @@ - - + +
-
Skip to main content

Interface: IButtonBlock

@headstartwp/core.react.IButtonBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: ButtonBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsButtonBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: IButtonBlock

@headstartwp/core.react.IButtonBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: ButtonBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsButtonBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IButtonsBlock/index.html b/api/interfaces/headstartwp_core.react.IButtonsBlock/index.html index 86719e609..c9db3f5c3 100644 --- a/api/interfaces/headstartwp_core.react.IButtonsBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IButtonsBlock/index.html @@ -7,14 +7,14 @@ - - + +
-
Skip to main content

Interface: IButtonsBlock

@headstartwp/core.react.IButtonsBlock

The interface for the ButtonsBlock component.

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: ButtonsBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsButtonsBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: IButtonsBlock

@headstartwp/core.react.IButtonsBlock

The interface for the ButtonsBlock component.

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: ButtonsBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsButtonsBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.ICodeBlock/index.html b/api/interfaces/headstartwp_core.react.ICodeBlock/index.html index 748016736..3f66e7cf6 100644 --- a/api/interfaces/headstartwp_core.react.ICodeBlock/index.html +++ b/api/interfaces/headstartwp_core.react.ICodeBlock/index.html @@ -7,14 +7,14 @@ - - + +
-
Skip to main content

Interface: ICodeBlock

@headstartwp/core.react.ICodeBlock

The interface for the CodeBlock component.

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: CodeBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsCodeBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: ICodeBlock

@headstartwp/core.react.ICodeBlock

The interface for the CodeBlock component.

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: CodeBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsCodeBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IColumnBlock/index.html b/api/interfaces/headstartwp_core.react.IColumnBlock/index.html index 30ca60585..98d7eb9c2 100644 --- a/api/interfaces/headstartwp_core.react.IColumnBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IColumnBlock/index.html @@ -7,14 +7,14 @@ - - + +
-
Skip to main content

Interface: IColumnBlock

@headstartwp/core.react.IColumnBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: ColumnBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsColumnBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: IColumnBlock

@headstartwp/core.react.IColumnBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: ColumnBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsColumnBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IColumnsBlock/index.html b/api/interfaces/headstartwp_core.react.IColumnsBlock/index.html index 100af18d6..74da0e02e 100644 --- a/api/interfaces/headstartwp_core.react.IColumnsBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IColumnsBlock/index.html @@ -7,14 +7,14 @@ - - + +
-
Skip to main content

Interface: IColumnsBlock

@headstartwp/core.react.IColumnsBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: ColumnsBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsColumnsBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: IColumnsBlock

@headstartwp/core.react.IColumnsBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: ColumnsBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsColumnsBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.ICoverBlock/index.html b/api/interfaces/headstartwp_core.react.ICoverBlock/index.html index 3102470ca..9579be7f9 100644 --- a/api/interfaces/headstartwp_core.react.ICoverBlock/index.html +++ b/api/interfaces/headstartwp_core.react.ICoverBlock/index.html @@ -7,14 +7,14 @@ - - + +
-
Skip to main content

Interface: ICoverBlock

@headstartwp/core.react.ICoverBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: CoverBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsCoverBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: ICoverBlock

@headstartwp/core.react.ICoverBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: CoverBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsCoverBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IDataWPBlock/index.html b/api/interfaces/headstartwp_core.react.IDataWPBlock/index.html index a2634a13f..ff2073a5a 100644 --- a/api/interfaces/headstartwp_core.react.IDataWPBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IDataWPBlock/index.html @@ -7,13 +7,13 @@ - - + +
Skip to main content

Interface: IDataWPBlock

@headstartwp/core.react.IDataWPBlock

Indexable​

▪ [key: string]: unknown

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - + + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IFileBlock/index.html b/api/interfaces/headstartwp_core.react.IFileBlock/index.html index 1bc440754..fdec01bcf 100644 --- a/api/interfaces/headstartwp_core.react.IFileBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IFileBlock/index.html @@ -7,14 +7,14 @@ - - + +
-
Skip to main content

Interface: IFileBlock

@headstartwp/core.react.IFileBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: FileBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsFileBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: IFileBlock

@headstartwp/core.react.IFileBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: FileBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsFileBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IGroupBlock/index.html b/api/interfaces/headstartwp_core.react.IGroupBlock/index.html index 06f961b6c..e82bb3010 100644 --- a/api/interfaces/headstartwp_core.react.IGroupBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IGroupBlock/index.html @@ -7,14 +7,14 @@ - - + +
-
Skip to main content

Interface: IGroupBlock

@headstartwp/core.react.IGroupBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: GroupBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsGroupBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: IGroupBlock

@headstartwp/core.react.IGroupBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: GroupBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsGroupBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IHeadingBlock/index.html b/api/interfaces/headstartwp_core.react.IHeadingBlock/index.html index edf3513a0..f0bb94a7a 100644 --- a/api/interfaces/headstartwp_core.react.IHeadingBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IHeadingBlock/index.html @@ -7,14 +7,14 @@ - - + +
-
Skip to main content

Interface: IHeadingBlock

@headstartwp/core.react.IHeadingBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: HeadingBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsHeadingBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: IHeadingBlock

@headstartwp/core.react.IHeadingBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: HeadingBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsHeadingBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IImageBlock/index.html b/api/interfaces/headstartwp_core.react.IImageBlock/index.html index 258455552..921091e00 100644 --- a/api/interfaces/headstartwp_core.react.IImageBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IImageBlock/index.html @@ -7,14 +7,14 @@ - - + +
-
Skip to main content

Interface: IImageBlock

@headstartwp/core.react.IImageBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: ImageBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsImageBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: IImageBlock

@headstartwp/core.react.IImageBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: ImageBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsImageBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IListBlock/index.html b/api/interfaces/headstartwp_core.react.IListBlock/index.html index 574afc0e6..4300e7dcc 100644 --- a/api/interfaces/headstartwp_core.react.IListBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IListBlock/index.html @@ -7,14 +7,14 @@ - - + +
-
Skip to main content

Interface: IListBlock

@headstartwp/core.react.IListBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: ListBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsListBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: IListBlock

@headstartwp/core.react.IListBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: ListBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsListBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IMediaTextBlock/index.html b/api/interfaces/headstartwp_core.react.IMediaTextBlock/index.html index 851db8baa..8f799035a 100644 --- a/api/interfaces/headstartwp_core.react.IMediaTextBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IMediaTextBlock/index.html @@ -7,14 +7,14 @@ - - + +
-
Skip to main content

Interface: IMediaTextBlock

@headstartwp/core.react.IMediaTextBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: MediaTextBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsMediaTextBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: IMediaTextBlock

@headstartwp/core.react.IMediaTextBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: MediaTextBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsMediaTextBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IParagraphBlock/index.html b/api/interfaces/headstartwp_core.react.IParagraphBlock/index.html index 9c9b9feac..66a34b5cb 100644 --- a/api/interfaces/headstartwp_core.react.IParagraphBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IParagraphBlock/index.html @@ -7,14 +7,14 @@ - - + +
-
Skip to main content

Interface: IParagraphBlock

@headstartwp/core.react.IParagraphBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: ParagraphBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsParagraphBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: IParagraphBlock

@headstartwp/core.react.IParagraphBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: ParagraphBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsParagraphBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IPreformattedBlock/index.html b/api/interfaces/headstartwp_core.react.IPreformattedBlock/index.html index db02169be..e41e821f2 100644 --- a/api/interfaces/headstartwp_core.react.IPreformattedBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IPreformattedBlock/index.html @@ -7,14 +7,14 @@ - - + +
-
Skip to main content

Interface: IPreformattedBlock

@headstartwp/core.react.IPreformattedBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: PreformattedBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsPreformattedBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: IPreformattedBlock

@headstartwp/core.react.IPreformattedBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: PreformattedBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsPreformattedBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IPullQuoteBlock/index.html b/api/interfaces/headstartwp_core.react.IPullQuoteBlock/index.html index b5490f1d3..2c00a096b 100644 --- a/api/interfaces/headstartwp_core.react.IPullQuoteBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IPullQuoteBlock/index.html @@ -7,14 +7,14 @@ - - + +
-
Skip to main content

Interface: IPullQuoteBlock

@headstartwp/core.react.IPullQuoteBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: PullQuoteBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsPullQuoteBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: IPullQuoteBlock

@headstartwp/core.react.IPullQuoteBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: PullQuoteBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsPullQuoteBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IQuoteBlock/index.html b/api/interfaces/headstartwp_core.react.IQuoteBlock/index.html index 0921c6d72..23c223212 100644 --- a/api/interfaces/headstartwp_core.react.IQuoteBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IQuoteBlock/index.html @@ -7,14 +7,14 @@ - - + +
-
Skip to main content

Interface: IQuoteBlock

@headstartwp/core.react.IQuoteBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: QuoteBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsQuoteBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: IQuoteBlock

@headstartwp/core.react.IQuoteBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: QuoteBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsQuoteBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.ISeparatorBlock/index.html b/api/interfaces/headstartwp_core.react.ISeparatorBlock/index.html index 71bfbd0d4..b5945b94d 100644 --- a/api/interfaces/headstartwp_core.react.ISeparatorBlock/index.html +++ b/api/interfaces/headstartwp_core.react.ISeparatorBlock/index.html @@ -7,14 +7,14 @@ - - + +
-
Skip to main content

Interface: ISeparatorBlock

@headstartwp/core.react.ISeparatorBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: SeparatorBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsSeparatorBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: ISeparatorBlock

@headstartwp/core.react.ISeparatorBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: SeparatorBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsSeparatorBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.ISpacerBlock/index.html b/api/interfaces/headstartwp_core.react.ISpacerBlock/index.html index dcca94957..ed541be56 100644 --- a/api/interfaces/headstartwp_core.react.ISpacerBlock/index.html +++ b/api/interfaces/headstartwp_core.react.ISpacerBlock/index.html @@ -7,14 +7,14 @@ - - + +
-
Skip to main content

Interface: ISpacerBlock

@headstartwp/core.react.ISpacerBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: SpacerBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsSpacerBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: ISpacerBlock

@headstartwp/core.react.ISpacerBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: SpacerBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsSpacerBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.ITableBlock/index.html b/api/interfaces/headstartwp_core.react.ITableBlock/index.html index 31a7bc699..a36aeae51 100644 --- a/api/interfaces/headstartwp_core.react.ITableBlock/index.html +++ b/api/interfaces/headstartwp_core.react.ITableBlock/index.html @@ -7,14 +7,14 @@ - - + +
-
Skip to main content

Interface: ITableBlock

@headstartwp/core.react.ITableBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: TableBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsTableBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: ITableBlock

@headstartwp/core.react.ITableBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: TableBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsTableBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IVerseBlock/index.html b/api/interfaces/headstartwp_core.react.IVerseBlock/index.html index 5b3b91eb2..5212bf08a 100644 --- a/api/interfaces/headstartwp_core.react.IVerseBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IVerseBlock/index.html @@ -7,14 +7,14 @@ - - + +
-
Skip to main content

Interface: IVerseBlock

@headstartwp/core.react.IVerseBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: VerseBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsVerseBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: IVerseBlock

@headstartwp/core.react.IVerseBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: VerseBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsVerseBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock/index.html b/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock/index.html index f65b6fa91..b68f07e24 100644 --- a/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock/index.html +++ b/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock/index.html @@ -7,14 +7,14 @@ - - + +
-
Skip to main content

Interface: IYoutubeLiteBlock

@headstartwp/core.react.IYoutubeLiteBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: YoutubeLiteBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsYoutubeLiteBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child -of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: IYoutubeLiteBlock

@headstartwp/core.react.IYoutubeLiteBlock

The common interface for a block transform component

Hierarchy​

Properties​

children​

• Optional children: ReactNode

The children of the domNode that was replaced with the react component

Note: the children of the domNode are recursively parsed.

Inherited from​

IBlock.children

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:53

classList​

• Optional classList: string | string[]

The class name of the domNode that should be replaced with the react component

If tagName is specified, then classList is mandatory

Inherited from​

IBlock.classList

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:41

className​

• Optional className: string

Inherited from​

IBlock.className

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:66

component​

• component: (props: YoutubeLiteBlockProps) => null | ReactElement<any, string | JSXElementConstructor<any>>

Type declaration​

▸ (props): null | ReactElement<any, string | JSXElementConstructor<any>>

Parameters​
NameType
propsYoutubeLiteBlockProps
Returns​

null | ReactElement<any, string | JSXElementConstructor<any>>

Inherited from​

IBlock.component

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:67

domNode​

• Optional domNode: Element

Inherited from​

IBlock.domNode

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:65

exclude​

• Optional exclude: (childNode: Element, site?: HeadlessConfig) => boolean

Type declaration​

▸ (childNode, site?): boolean

An optional exclude function that also receives a domNode and is executed against every child +of the node being replaced with a react component.

This is useful to selectively disregard certain children of a node when replacing with a react component.

Parameters​
NameType
childNodeElement
site?HeadlessConfig
Returns​

boolean

Inherited from​

IBlock.exclude

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:27

style​

• Optional style: Record<string, string>

The style tag of the domNode as an object.

Inherited from​

IBlock.style

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:58

tagName​

• Optional tagName: string

The tag name of the domNode that should be replaced with the react component

If a test function is not supplied, then passing tagName is mandatory

Inherited from​

IBlock.tagName

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:34

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.ImageBlockProps/index.html b/api/interfaces/headstartwp_core.react.ImageBlockProps/index.html index 885f3a9c1..e56456efe 100644 --- a/api/interfaces/headstartwp_core.react.ImageBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.ImageBlockProps/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: ImageBlockProps

@headstartwp/core.react.ImageBlockProps

Hierarchy​

Properties​

alt​

• Optional alt: string

Defined in​

packages/core/src/react/blocks/ImageBlock.tsx:14

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

height​

• Optional height: number

Defined in​

packages/core/src/react/blocks/ImageBlock.tsx:10

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

linkDestination​

• Optional linkDestination: string

Defined in​

packages/core/src/react/blocks/ImageBlock.tsx:12

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

sizeSlug​

• Optional sizeSlug: string

Defined in​

packages/core/src/react/blocks/ImageBlock.tsx:11

src​

• src: string

Defined in​

packages/core/src/react/blocks/ImageBlock.tsx:13

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

width​

• Optional width: number

Defined in​

packages/core/src/react/blocks/ImageBlock.tsx:9

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: ImageBlockProps

@headstartwp/core.react.ImageBlockProps

Hierarchy​

Properties​

alt​

• Optional alt: string

Defined in​

packages/core/src/react/blocks/ImageBlock.tsx:14

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

height​

• Optional height: number

Defined in​

packages/core/src/react/blocks/ImageBlock.tsx:10

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

linkDestination​

• Optional linkDestination: string

Defined in​

packages/core/src/react/blocks/ImageBlock.tsx:12

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

sizeSlug​

• Optional sizeSlug: string

Defined in​

packages/core/src/react/blocks/ImageBlock.tsx:11

src​

• src: string

Defined in​

packages/core/src/react/blocks/ImageBlock.tsx:13

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

width​

• Optional width: number

Defined in​

packages/core/src/react/blocks/ImageBlock.tsx:9

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.ListBlockProps/index.html b/api/interfaces/headstartwp_core.react.ListBlockProps/index.html index 6f53682b8..0f8ef80d0 100644 --- a/api/interfaces/headstartwp_core.react.ListBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.ListBlockProps/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: ListBlockProps

@headstartwp/core.react.ListBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

ordered​

• ordered: boolean

Defined in​

packages/core/src/react/blocks/ListBlock.tsx:7

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: ListBlockProps

@headstartwp/core.react.ListBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

ordered​

• ordered: boolean

Defined in​

packages/core/src/react/blocks/ListBlock.tsx:7

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.MediaTextBlockProps/index.html b/api/interfaces/headstartwp_core.react.MediaTextBlockProps/index.html index 7e9f6db4a..6d2d79d9b 100644 --- a/api/interfaces/headstartwp_core.react.MediaTextBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.MediaTextBlockProps/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: MediaTextBlockProps

@headstartwp/core.react.MediaTextBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

focalPoint​

• Optional focalPoint: Object

Type declaration​

NameType
xstring | number
ystring | number

Defined in​

packages/core/src/react/blocks/MediaTextBlock.tsx:13

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

imageFill​

• imageFill: boolean

Defined in​

packages/core/src/react/blocks/MediaTextBlock.tsx:12

mediaId​

• Optional mediaId: number

Defined in​

packages/core/src/react/blocks/MediaTextBlock.tsx:8

mediaPosition​

• Optional mediaPosition: "left" | "right"

Defined in​

packages/core/src/react/blocks/MediaTextBlock.tsx:7

mediaSizeSlug​

• Optional mediaSizeSlug: string

Defined in​

packages/core/src/react/blocks/MediaTextBlock.tsx:10

mediaType​

• Optional mediaType: "image" | "video"

Defined in​

packages/core/src/react/blocks/MediaTextBlock.tsx:9

mediaWidth​

• Optional mediaWidth: number

Defined in​

packages/core/src/react/blocks/MediaTextBlock.tsx:11

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

verticalAlignment​

• Optional verticalAlignment: "center" | "top" | "bottom"

Defined in​

packages/core/src/react/blocks/MediaTextBlock.tsx:17

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: MediaTextBlockProps

@headstartwp/core.react.MediaTextBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

focalPoint​

• Optional focalPoint: Object

Type declaration​

NameType
xstring | number
ystring | number

Defined in​

packages/core/src/react/blocks/MediaTextBlock.tsx:13

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

imageFill​

• imageFill: boolean

Defined in​

packages/core/src/react/blocks/MediaTextBlock.tsx:12

mediaId​

• Optional mediaId: number

Defined in​

packages/core/src/react/blocks/MediaTextBlock.tsx:8

mediaPosition​

• Optional mediaPosition: "left" | "right"

Defined in​

packages/core/src/react/blocks/MediaTextBlock.tsx:7

mediaSizeSlug​

• Optional mediaSizeSlug: string

Defined in​

packages/core/src/react/blocks/MediaTextBlock.tsx:10

mediaType​

• Optional mediaType: "image" | "video"

Defined in​

packages/core/src/react/blocks/MediaTextBlock.tsx:9

mediaWidth​

• Optional mediaWidth: number

Defined in​

packages/core/src/react/blocks/MediaTextBlock.tsx:11

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

verticalAlignment​

• Optional verticalAlignment: "center" | "top" | "bottom"

Defined in​

packages/core/src/react/blocks/MediaTextBlock.tsx:17

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.ParagraphBlockProps/index.html b/api/interfaces/headstartwp_core.react.ParagraphBlockProps/index.html index f6f9f1cc3..8b937ef0b 100644 --- a/api/interfaces/headstartwp_core.react.ParagraphBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.ParagraphBlockProps/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: ParagraphBlockProps

@headstartwp/core.react.ParagraphBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

dropCap​

• Optional dropCap: boolean

Defined in​

packages/core/src/react/blocks/ParagraphBlock.tsx:8

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: ParagraphBlockProps

@headstartwp/core.react.ParagraphBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

dropCap​

• Optional dropCap: boolean

Defined in​

packages/core/src/react/blocks/ParagraphBlock.tsx:8

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.PreformattedBlockProps/index.html b/api/interfaces/headstartwp_core.react.PreformattedBlockProps/index.html index 62d118a1c..5e6044e0f 100644 --- a/api/interfaces/headstartwp_core.react.PreformattedBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.PreformattedBlockProps/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: PreformattedBlockProps

@headstartwp/core.react.PreformattedBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: PreformattedBlockProps

@headstartwp/core.react.PreformattedBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.PullQuoteBlockProps/index.html b/api/interfaces/headstartwp_core.react.PullQuoteBlockProps/index.html index afa444e45..2090c4aff 100644 --- a/api/interfaces/headstartwp_core.react.PullQuoteBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.PullQuoteBlockProps/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: PullQuoteBlockProps

@headstartwp/core.react.PullQuoteBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

borderColor​

• Optional borderColor: string

Defined in​

packages/core/src/react/blocks/PullQuote.tsx:10

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

cite​

• cite: string

Defined in​

packages/core/src/react/blocks/PullQuote.tsx:9

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

quote​

• quote: string

Defined in​

packages/core/src/react/blocks/PullQuote.tsx:8

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: PullQuoteBlockProps

@headstartwp/core.react.PullQuoteBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

borderColor​

• Optional borderColor: string

Defined in​

packages/core/src/react/blocks/PullQuote.tsx:10

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

cite​

• cite: string

Defined in​

packages/core/src/react/blocks/PullQuote.tsx:9

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

quote​

• quote: string

Defined in​

packages/core/src/react/blocks/PullQuote.tsx:8

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.QuoteBlockProps/index.html b/api/interfaces/headstartwp_core.react.QuoteBlockProps/index.html index 8658f1326..57b066da3 100644 --- a/api/interfaces/headstartwp_core.react.QuoteBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.QuoteBlockProps/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: QuoteBlockProps

@headstartwp/core.react.QuoteBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: QuoteBlockProps

@headstartwp/core.react.QuoteBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.SafeHtmlProps/index.html b/api/interfaces/headstartwp_core.react.SafeHtmlProps/index.html index c1fa0e6c3..aa02c8100 100644 --- a/api/interfaces/headstartwp_core.react.SafeHtmlProps/index.html +++ b/api/interfaces/headstartwp_core.react.SafeHtmlProps/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: SafeHtmlProps

@headstartwp/core.react.SafeHtmlProps

Properties​

html​

• html: string

The HTML string to be rendered.

<SafeHtml html="<div><p>hello world</p> div content</div>" />

Defined in​

packages/core/src/react/components/SafeHtml.tsx:14

ksesAllowList​

• Optional ksesAllowList: IWhiteList

The allow list for the parser

<SafeHtml
        html="<div><p>hello world</p> div content</div>"
        ksesAllowList={{ div: [] }}
/>

Defined in​

packages/core/src/react/components/SafeHtml.tsx:26

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: SafeHtmlProps

@headstartwp/core.react.SafeHtmlProps

Properties​

html​

• html: string

The HTML string to be rendered.

<SafeHtml html="<div><p>hello world</p> div content</div>" />

Defined in​

packages/core/src/react/components/SafeHtml.tsx:14

ksesAllowList​

• Optional ksesAllowList: IWhiteList

The allow list for the parser

<SafeHtml
        html="<div><p>hello world</p> div content</div>"
        ksesAllowList={{ div: [] }}
/>

Defined in​

packages/core/src/react/components/SafeHtml.tsx:26

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.SeparatorBlockProps/index.html b/api/interfaces/headstartwp_core.react.SeparatorBlockProps/index.html index 368bc9248..6f0b9de86 100644 --- a/api/interfaces/headstartwp_core.react.SeparatorBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.SeparatorBlockProps/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: SeparatorBlockProps

@headstartwp/core.react.SeparatorBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: SeparatorBlockProps

@headstartwp/core.react.SeparatorBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties/index.html b/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties/index.html index e870198d9..6f6123898 100644 --- a/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties/index.html +++ b/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties/index.html @@ -7,13 +7,13 @@ - - + +
Skip to main content
Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - + + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.SettingsProperties/index.html b/api/interfaces/headstartwp_core.react.SettingsProperties/index.html index f8f94626f..d6de074af 100644 --- a/api/interfaces/headstartwp_core.react.SettingsProperties/index.html +++ b/api/interfaces/headstartwp_core.react.SettingsProperties/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: SettingsProperties

@headstartwp/core.react.SettingsProperties

Indexable​

▪ [k: string]: unknown

Properties​

appearanceTools​

• Optional appearanceTools: boolean

Setting that enables ui tools.

Defined in​

packages/core/src/react/provider/types.ts:358

border​

• Optional border: Object

Settings related to borders.

Type declaration​

NameTypeDescription
color?booleanAllow users to set custom border colors.
radius?booleanAllow users to set custom border radius.
style?booleanAllow users to set custom border styles.
width?booleanAllow users to set custom border widths.

Defined in​

packages/core/src/react/provider/types.ts:362

color​

• Optional color: Object

Settings related to colors.

Type declaration​

NameTypeDescription
background?booleanAllow users to set background colors.
custom?booleanAllow users to select custom colors.
customDuotone?booleanAllow users to create custom duotone filters.
customGradient?booleanAllow users to create custom gradients.
defaultGradients?booleanAllow users to choose colors from the default gradients.
defaultPalette?booleanAllow users to choose colors from the default palette.
duotone?SettingsDuotoneDuotone presets for the duotone picker. Doesn't generate classes or properties.
gradients?SettingsGradientGradient presets for the gradient picker. Generates a single class (.has-{slug}-background) and custom property (--wp--preset--gradient--{slug}) per preset value.
link?booleanAllow users to set link colors.
palette?SettingsColorPaletteColor palette presets for the color picker. Generates three classes (.has-{slug}-color, .has-{slug}-background-color, and .has-{slug}-border-color) and a single custom property (--wp--preset--color--{slug}) per preset value.
text?booleanAllow users to set text colors.

Defined in​

packages/core/src/react/provider/types.ts:383

custom​

• Optional custom: Object

Generate custom CSS custom properties of the form --wp--custom--{key}--{nested-key}: {value};. camelCased keys are transformed to kebab-case as to follow the CSS property naming schema. Keys at different depth levels are separated by --, so keys should not include -- in the name.

Index signature​

▪ [k: string]: string | number | SettingsCustomAdditionalProperties

Defined in​

packages/core/src/react/provider/types.ts:543

layout​

• Optional layout: Object

Settings related to layout.

Type declaration​

NameTypeDescription
contentSize?stringSets the max-width of the content.
wideSize?stringSets the max-width of wide (.alignwide) content.

Defined in​

packages/core/src/react/provider/types.ts:435

spacing​

• Optional spacing: Object

Settings related to spacing.

Type declaration​

NameTypeDescription
blockGap?null | booleanEnables --wp--style--block-gap to be generated from styles.spacing.blockGap. A value of null instead of false further disables layout styles from being generated.
margin?booleanAllow users to set a custom margin.
padding?booleanAllow users to set a custom padding.
units?string[]List of units the user can use for spacing values.

Defined in​

packages/core/src/react/provider/types.ts:448

typography​

• Optional typography: Object

Settings related to typography.

Type declaration​

NameTypeDescription
customFontSize?booleanAllow users to set custom font sizes.
dropCap?booleanEnable drop cap.
fontFamilies?{ fontFamily?: string ; name?: string ; slug?: string }[]Font family presets for the font family selector. Generates a single custom property (--wp--preset--font-family--{slug}) per preset value.
fontSizes?{ name?: string ; size?: string ; slug?: string }[]Font size presets for the font size selector. Generates a single class (.has-{slug}-color) and custom property (--wp--preset--font-size--{slug}) per preset value.
fontStyle?booleanAllow users to set custom font styles.
fontWeight?booleanAllow users to set custom font weights.
letterSpacing?booleanAllow users to set custom letter spacing.
lineHeight?booleanAllow users to set custom line height.
textDecoration?booleanAllow users to set custom text decorations.
textTransform?booleanAllow users to set custom text transforms.

Defined in​

packages/core/src/react/provider/types.ts:470

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: SettingsProperties

@headstartwp/core.react.SettingsProperties

Indexable​

▪ [k: string]: unknown

Properties​

appearanceTools​

• Optional appearanceTools: boolean

Setting that enables ui tools.

Defined in​

packages/core/src/react/provider/types.ts:358

border​

• Optional border: Object

Settings related to borders.

Type declaration​

NameTypeDescription
color?booleanAllow users to set custom border colors.
radius?booleanAllow users to set custom border radius.
style?booleanAllow users to set custom border styles.
width?booleanAllow users to set custom border widths.

Defined in​

packages/core/src/react/provider/types.ts:362

color​

• Optional color: Object

Settings related to colors.

Type declaration​

NameTypeDescription
background?booleanAllow users to set background colors.
custom?booleanAllow users to select custom colors.
customDuotone?booleanAllow users to create custom duotone filters.
customGradient?booleanAllow users to create custom gradients.
defaultGradients?booleanAllow users to choose colors from the default gradients.
defaultPalette?booleanAllow users to choose colors from the default palette.
duotone?SettingsDuotoneDuotone presets for the duotone picker. Doesn't generate classes or properties.
gradients?SettingsGradientGradient presets for the gradient picker. Generates a single class (.has-{slug}-background) and custom property (--wp--preset--gradient--{slug}) per preset value.
link?booleanAllow users to set link colors.
palette?SettingsColorPaletteColor palette presets for the color picker. Generates three classes (.has-{slug}-color, .has-{slug}-background-color, and .has-{slug}-border-color) and a single custom property (--wp--preset--color--{slug}) per preset value.
text?booleanAllow users to set text colors.

Defined in​

packages/core/src/react/provider/types.ts:383

custom​

• Optional custom: Object

Generate custom CSS custom properties of the form --wp--custom--{key}--{nested-key}: {value};. camelCased keys are transformed to kebab-case as to follow the CSS property naming schema. Keys at different depth levels are separated by --, so keys should not include -- in the name.

Index signature​

▪ [k: string]: string | number | SettingsCustomAdditionalProperties

Defined in​

packages/core/src/react/provider/types.ts:543

layout​

• Optional layout: Object

Settings related to layout.

Type declaration​

NameTypeDescription
contentSize?stringSets the max-width of the content.
wideSize?stringSets the max-width of wide (.alignwide) content.

Defined in​

packages/core/src/react/provider/types.ts:435

spacing​

• Optional spacing: Object

Settings related to spacing.

Type declaration​

NameTypeDescription
blockGap?null | booleanEnables --wp--style--block-gap to be generated from styles.spacing.blockGap. A value of null instead of false further disables layout styles from being generated.
margin?booleanAllow users to set a custom margin.
padding?booleanAllow users to set a custom padding.
units?string[]List of units the user can use for spacing values.

Defined in​

packages/core/src/react/provider/types.ts:448

typography​

• Optional typography: Object

Settings related to typography.

Type declaration​

NameTypeDescription
customFontSize?booleanAllow users to set custom font sizes.
dropCap?booleanEnable drop cap.
fontFamilies?{ fontFamily?: string ; name?: string ; slug?: string }[]Font family presets for the font family selector. Generates a single custom property (--wp--preset--font-family--{slug}) per preset value.
fontSizes?{ name?: string ; size?: string ; slug?: string }[]Font size presets for the font size selector. Generates a single class (.has-{slug}-color) and custom property (--wp--preset--font-size--{slug}) per preset value.
fontStyle?booleanAllow users to set custom font styles.
fontWeight?booleanAllow users to set custom font weights.
letterSpacing?booleanAllow users to set custom letter spacing.
lineHeight?booleanAllow users to set custom line height.
textDecoration?booleanAllow users to set custom text decorations.
textTransform?booleanAllow users to set custom text transforms.

Defined in​

packages/core/src/react/provider/types.ts:470

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.SpacerBlockProps/index.html b/api/interfaces/headstartwp_core.react.SpacerBlockProps/index.html index fd93e191e..e2e314f40 100644 --- a/api/interfaces/headstartwp_core.react.SpacerBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.SpacerBlockProps/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: SpacerBlockProps

@headstartwp/core.react.SpacerBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

height​

• Optional height: string

Defined in​

packages/core/src/react/blocks/SpacerBlock.tsx:7

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: SpacerBlockProps

@headstartwp/core.react.SpacerBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

height​

• Optional height: string

Defined in​

packages/core/src/react/blocks/SpacerBlock.tsx:7

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete/index.html b/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete/index.html index c24afb16e..54b6dec9a 100644 --- a/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete/index.html +++ b/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: StylesElementsPropertiesComplete

@headstartwp/core.react.StylesElementsPropertiesComplete

Properties​

h1​

• Optional h1: StylesPropertiesComplete

Defined in​

packages/core/src/react/provider/types.ts:682

h2​

• Optional h2: StylesPropertiesComplete

Defined in​

packages/core/src/react/provider/types.ts:683

h3​

• Optional h3: StylesPropertiesComplete

Defined in​

packages/core/src/react/provider/types.ts:684

h4​

• Optional h4: StylesPropertiesComplete

Defined in​

packages/core/src/react/provider/types.ts:685

h5​

• Optional h5: StylesPropertiesComplete

Defined in​

packages/core/src/react/provider/types.ts:686

h6​

• Optional h6: StylesPropertiesComplete

Defined in​

packages/core/src/react/provider/types.ts:687

• Optional link: StylesPropertiesComplete

Defined in​

packages/core/src/react/provider/types.ts:681

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: StylesElementsPropertiesComplete

@headstartwp/core.react.StylesElementsPropertiesComplete

Properties​

h1​

• Optional h1: StylesPropertiesComplete

Defined in​

packages/core/src/react/provider/types.ts:682

h2​

• Optional h2: StylesPropertiesComplete

Defined in​

packages/core/src/react/provider/types.ts:683

h3​

• Optional h3: StylesPropertiesComplete

Defined in​

packages/core/src/react/provider/types.ts:684

h4​

• Optional h4: StylesPropertiesComplete

Defined in​

packages/core/src/react/provider/types.ts:685

h5​

• Optional h5: StylesPropertiesComplete

Defined in​

packages/core/src/react/provider/types.ts:686

h6​

• Optional h6: StylesPropertiesComplete

Defined in​

packages/core/src/react/provider/types.ts:687

• Optional link: StylesPropertiesComplete

Defined in​

packages/core/src/react/provider/types.ts:681

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.StylesProperties/index.html b/api/interfaces/headstartwp_core.react.StylesProperties/index.html index be842e560..12cd32b00 100644 --- a/api/interfaces/headstartwp_core.react.StylesProperties/index.html +++ b/api/interfaces/headstartwp_core.react.StylesProperties/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: StylesProperties

@headstartwp/core.react.StylesProperties

Indexable​

▪ [k: string]: unknown

Properties​

border​

• Optional border: Object

Border styles.

Type declaration​

NameTypeDescription
color?stringSets the border-color CSS property.
radius?stringSets the border-radius CSS property.
style?stringSets the border-style CSS property.
width?stringSets the border-width CSS property.

Defined in​

packages/core/src/react/provider/types.ts:555

color​

• Optional color: Object

Color styles.

Type declaration​

NameTypeDescription
background?stringSets the background-color CSS property.
gradient?stringSets the background CSS property.
text?stringSets the color CSS property.

Defined in​

packages/core/src/react/provider/types.ts:576

spacing​

• Optional spacing: Object

Spacing styles.

Type declaration​

NameTypeDescription
blockGap?stringSets the --wp--style--block-gap CSS custom property when settings.spacing.blockGap is true.
margin?{ bottom?: string ; left?: string ; right?: string ; top?: string }Margin styles.
margin.bottom?stringSets the margin-bottom CSS property.
margin.left?stringSets the margin-left CSS property.
margin.right?stringSets the margin-right CSS property.
margin.top?stringSets the margin-top CSS property.
padding?{ bottom?: string ; left?: string ; right?: string ; top?: string }Padding styles.
padding.bottom?stringSets the padding-bottom CSS property.
padding.left?stringSets the padding-left CSS property.
padding.right?stringSets the padding-right CSS property.
padding.top?stringSets the padding-top CSS property.

Defined in​

packages/core/src/react/provider/types.ts:593

typography​

• Optional typography: Object

Typography styles.

Type declaration​

NameTypeDescription
fontFamily?stringSets the font-family CSS property.
fontSize?stringSets the font-size CSS property.
fontStyle?stringSets the font-style CSS property.
fontWeight?stringSets the font-weight CSS property.
letterSpacing?stringSets the letter-spacing CSS property.
lineHeight?stringSets the line-height CSS property.
textDecoration?stringSets the text-decoration CSS property.
textTransform?stringSets the text-transform CSS property.

Defined in​

packages/core/src/react/provider/types.ts:644

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: StylesProperties

@headstartwp/core.react.StylesProperties

Indexable​

▪ [k: string]: unknown

Properties​

border​

• Optional border: Object

Border styles.

Type declaration​

NameTypeDescription
color?stringSets the border-color CSS property.
radius?stringSets the border-radius CSS property.
style?stringSets the border-style CSS property.
width?stringSets the border-width CSS property.

Defined in​

packages/core/src/react/provider/types.ts:555

color​

• Optional color: Object

Color styles.

Type declaration​

NameTypeDescription
background?stringSets the background-color CSS property.
gradient?stringSets the background CSS property.
text?stringSets the color CSS property.

Defined in​

packages/core/src/react/provider/types.ts:576

spacing​

• Optional spacing: Object

Spacing styles.

Type declaration​

NameTypeDescription
blockGap?stringSets the --wp--style--block-gap CSS custom property when settings.spacing.blockGap is true.
margin?{ bottom?: string ; left?: string ; right?: string ; top?: string }Margin styles.
margin.bottom?stringSets the margin-bottom CSS property.
margin.left?stringSets the margin-left CSS property.
margin.right?stringSets the margin-right CSS property.
margin.top?stringSets the margin-top CSS property.
padding?{ bottom?: string ; left?: string ; right?: string ; top?: string }Padding styles.
padding.bottom?stringSets the padding-bottom CSS property.
padding.left?stringSets the padding-left CSS property.
padding.right?stringSets the padding-right CSS property.
padding.top?stringSets the padding-top CSS property.

Defined in​

packages/core/src/react/provider/types.ts:593

typography​

• Optional typography: Object

Typography styles.

Type declaration​

NameTypeDescription
fontFamily?stringSets the font-family CSS property.
fontSize?stringSets the font-size CSS property.
fontStyle?stringSets the font-style CSS property.
fontWeight?stringSets the font-weight CSS property.
letterSpacing?stringSets the letter-spacing CSS property.
lineHeight?stringSets the line-height CSS property.
textDecoration?stringSets the text-decoration CSS property.
textTransform?stringSets the text-transform CSS property.

Defined in​

packages/core/src/react/provider/types.ts:644

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.TableBlockProps/index.html b/api/interfaces/headstartwp_core.react.TableBlockProps/index.html index c19b43154..bceb70aef 100644 --- a/api/interfaces/headstartwp_core.react.TableBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.TableBlockProps/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: TableBlockProps

@headstartwp/core.react.TableBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

hasFixedLayout​

• Optional hasFixedLayout: boolean

Defined in​

packages/core/src/react/blocks/TableBlock.tsx:7

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: TableBlockProps

@headstartwp/core.react.TableBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

hasFixedLayout​

• Optional hasFixedLayout: boolean

Defined in​

packages/core/src/react/blocks/TableBlock.tsx:7

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.Typography/index.html b/api/interfaces/headstartwp_core.react.Typography/index.html index 912619996..86db4bb99 100644 --- a/api/interfaces/headstartwp_core.react.Typography/index.html +++ b/api/interfaces/headstartwp_core.react.Typography/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: Typography

@headstartwp/core.react.Typography

Properties​

fontSize​

• fontSize: Object

Type declaration​

NameType
slugstring
valuestring

Defined in​

packages/core/src/react/blocks/types.ts:24

letterSpacing​

• Optional letterSpacing: string

Defined in​

packages/core/src/react/blocks/types.ts:37

lineHeight​

• Optional lineHeight: string

Defined in​

packages/core/src/react/blocks/types.ts:35

supportsCustomFontSize​

• supportsCustomFontSize: boolean

Defined in​

packages/core/src/react/blocks/types.ts:29

supportsFontStyle​

• supportsFontStyle: boolean

Defined in​

packages/core/src/react/blocks/types.ts:28

supportsFontWeight​

• supportsFontWeight: boolean

Defined in​

packages/core/src/react/blocks/types.ts:30

supportsLetterSpacing​

• supportsLetterSpacing: boolean

Defined in​

packages/core/src/react/blocks/types.ts:31

supportsLineHeight​

• supportsLineHeight: boolean

Defined in​

packages/core/src/react/blocks/types.ts:32

supportsTextDecoration​

• supportsTextDecoration: boolean

Defined in​

packages/core/src/react/blocks/types.ts:33

supportsTextTransform​

• supportsTextTransform: boolean

Defined in​

packages/core/src/react/blocks/types.ts:34

textTransform​

• Optional textTransform: string

Defined in​

packages/core/src/react/blocks/types.ts:36

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: Typography

@headstartwp/core.react.Typography

Properties​

fontSize​

• fontSize: Object

Type declaration​

NameType
slugstring
valuestring

Defined in​

packages/core/src/react/blocks/types.ts:24

letterSpacing​

• Optional letterSpacing: string

Defined in​

packages/core/src/react/blocks/types.ts:37

lineHeight​

• Optional lineHeight: string

Defined in​

packages/core/src/react/blocks/types.ts:35

supportsCustomFontSize​

• supportsCustomFontSize: boolean

Defined in​

packages/core/src/react/blocks/types.ts:29

supportsFontStyle​

• supportsFontStyle: boolean

Defined in​

packages/core/src/react/blocks/types.ts:28

supportsFontWeight​

• supportsFontWeight: boolean

Defined in​

packages/core/src/react/blocks/types.ts:30

supportsLetterSpacing​

• supportsLetterSpacing: boolean

Defined in​

packages/core/src/react/blocks/types.ts:31

supportsLineHeight​

• supportsLineHeight: boolean

Defined in​

packages/core/src/react/blocks/types.ts:32

supportsTextDecoration​

• supportsTextDecoration: boolean

Defined in​

packages/core/src/react/blocks/types.ts:33

supportsTextTransform​

• supportsTextTransform: boolean

Defined in​

packages/core/src/react/blocks/types.ts:34

textTransform​

• Optional textTransform: string

Defined in​

packages/core/src/react/blocks/types.ts:36

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.VerseBlockProps/index.html b/api/interfaces/headstartwp_core.react.VerseBlockProps/index.html index eaffceec8..9c550180c 100644 --- a/api/interfaces/headstartwp_core.react.VerseBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.VerseBlockProps/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: VerseBlockProps

@headstartwp/core.react.VerseBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: VerseBlockProps

@headstartwp/core.react.VerseBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.WpThemeJSON/index.html b/api/interfaces/headstartwp_core.react.WpThemeJSON/index.html index eed38f423..4cec5a11a 100644 --- a/api/interfaces/headstartwp_core.react.WpThemeJSON/index.html +++ b/api/interfaces/headstartwp_core.react.WpThemeJSON/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: WpThemeJSON

@headstartwp/core.react.WpThemeJSON

Properties​

$schema​

• Optional $schema: string

JSON schema URI for theme.json.

Defined in​

packages/core/src/react/provider/types.ts:99

customTemplates​

• Optional customTemplates: { name: string ; postTypes?: string[] ; title: string }[]

Additional metadata for custom templates defined in the templates folder.

Defined in​

packages/core/src/react/provider/types.ts:319

settings​

• Optional settings: SettingsProperties & { blocks?: { core/archives?: SettingsPropertiesComplete ; core/audio?: SettingsPropertiesComplete ; core/block?: SettingsPropertiesComplete ; core/button?: SettingsPropertiesComplete ; core/buttons?: SettingsPropertiesComplete ; core/calendar?: SettingsPropertiesComplete ; core/categories?: SettingsPropertiesComplete ; core/code?: SettingsPropertiesComplete ; core/column?: SettingsPropertiesComplete ; core/columns?: SettingsPropertiesComplete ; core/comment-author-avatar?: SettingsPropertiesComplete ; core/comment-author-name?: SettingsPropertiesComplete ; core/comment-content?: SettingsPropertiesComplete ; core/comment-date?: SettingsPropertiesComplete ; core/comment-edit-link?: SettingsPropertiesComplete ; core/comment-reply-link?: SettingsPropertiesComplete ; core/comment-template?: SettingsPropertiesComplete ; core/comments-query-loop?: SettingsPropertiesComplete ; core/cover?: SettingsPropertiesComplete ; core/embed?: SettingsPropertiesComplete ; core/file?: SettingsPropertiesComplete ; core/freeform?: SettingsPropertiesComplete ; core/gallery?: SettingsPropertiesComplete ; core/group?: SettingsPropertiesComplete ; core/heading?: SettingsPropertiesComplete ; core/home-link?: SettingsPropertiesComplete ; core/html?: SettingsPropertiesComplete ; core/image?: SettingsPropertiesComplete ; core/latest-comments?: SettingsPropertiesComplete ; core/latest-posts?: SettingsPropertiesComplete ; core/legacy-widget?: SettingsPropertiesComplete ; core/list?: SettingsPropertiesComplete ; core/loginout?: SettingsPropertiesComplete ; core/media-text?: SettingsPropertiesComplete ; core/missing?: SettingsPropertiesComplete ; core/more?: SettingsPropertiesComplete ; core/navigation?: SettingsPropertiesComplete ; core/navigation-link?: SettingsPropertiesComplete ; core/nextpage?: SettingsPropertiesComplete ; core/page-list?: SettingsPropertiesComplete ; core/paragraph?: SettingsPropertiesComplete ; core/post-author?: SettingsPropertiesComplete ; core/post-comments?: SettingsPropertiesComplete ; core/post-comments-count?: SettingsPropertiesComplete ; core/post-comments-form?: SettingsPropertiesComplete ; core/post-comments-link?: SettingsPropertiesComplete ; core/post-content?: SettingsPropertiesComplete ; core/post-date?: SettingsPropertiesComplete ; core/post-excerpt?: SettingsPropertiesComplete ; core/post-featured-image?: SettingsPropertiesComplete ; core/post-navigation-link?: SettingsPropertiesComplete ; core/post-template?: SettingsPropertiesComplete ; core/post-terms?: SettingsPropertiesComplete ; core/post-title?: SettingsPropertiesComplete ; core/preformatted?: SettingsPropertiesComplete ; core/pullquote?: SettingsPropertiesComplete ; core/query?: SettingsPropertiesComplete ; core/query-pagination?: SettingsPropertiesComplete ; core/query-pagination-next?: SettingsPropertiesComplete ; core/query-pagination-numbers?: SettingsPropertiesComplete ; core/query-pagination-previous?: SettingsPropertiesComplete ; core/query-title?: SettingsPropertiesComplete ; core/quote?: SettingsPropertiesComplete ; core/rss?: SettingsPropertiesComplete ; core/search?: SettingsPropertiesComplete ; core/separator?: SettingsPropertiesComplete ; core/shortcode?: SettingsPropertiesComplete ; core/site-logo?: SettingsPropertiesComplete ; core/site-tagline?: SettingsPropertiesComplete ; core/site-title?: SettingsPropertiesComplete ; core/social-link?: SettingsPropertiesComplete ; core/social-links?: SettingsPropertiesComplete ; core/spacer?: SettingsPropertiesComplete ; core/table?: SettingsPropertiesComplete ; core/table-of-contents?: SettingsPropertiesComplete ; core/tag-cloud?: SettingsPropertiesComplete ; core/template-part?: SettingsPropertiesComplete ; core/term-description?: SettingsPropertiesComplete ; core/text-columns?: SettingsPropertiesComplete ; core/verse?: SettingsPropertiesComplete ; core/video?: SettingsPropertiesComplete ; core/widget-area?: SettingsPropertiesComplete ; core/widget-group?: SettingsPropertiesComplete } ; border?: { color?: boolean ; radius?: boolean ; style?: boolean ; width?: boolean } ; color?: { background?: boolean ; custom?: boolean ; customDuotone?: boolean ; customGradient?: boolean ; defaultGradients?: boolean ; defaultPalette?: boolean ; duotone?: SettingsDuotone ; gradients?: SettingsGradient ; link?: boolean ; palette?: SettingsColorPalette ; text?: boolean } ; custom?: { [k: string]: string | number | SettingsCustomAdditionalProperties; } ; layout?: { contentSize?: string ; wideSize?: string } ; spacing?: { blockGap?: null | boolean ; margin?: boolean ; padding?: boolean ; units?: string[] } ; typography?: { customFontSize?: boolean ; dropCap?: boolean ; fontFamilies?: { fontFamily?: string ; name?: string ; slug?: string }[] ; fontSizes?: { name?: string ; size?: string ; slug?: string }[] ; fontStyle?: boolean ; fontWeight?: boolean ; letterSpacing?: boolean ; lineHeight?: boolean ; textDecoration?: boolean ; textTransform?: boolean } }

Settings for the block editor and individual blocks. These include things like:

  • Which customization options should be available to the user.
  • The default colors, font sizes... available to the user.
  • CSS custom properties and class names used in styles.
  • And the default layout of the editor (widths and available alignments).

Defined in​

packages/core/src/react/provider/types.ts:111

styles​

• Optional styles: StylesProperties & { blocks?: { core/archives?: StylesPropertiesAndElementsComplete ; core/audio?: StylesPropertiesAndElementsComplete ; core/block?: StylesPropertiesAndElementsComplete ; core/button?: StylesPropertiesAndElementsComplete ; core/buttons?: StylesPropertiesAndElementsComplete ; core/calendar?: StylesPropertiesAndElementsComplete ; core/categories?: StylesPropertiesAndElementsComplete ; core/code?: StylesPropertiesAndElementsComplete ; core/column?: StylesPropertiesAndElementsComplete ; core/columns?: StylesPropertiesAndElementsComplete ; core/comment-author-avatar?: StylesPropertiesAndElementsComplete ; core/comment-author-name?: StylesPropertiesAndElementsComplete ; core/comment-content?: StylesPropertiesAndElementsComplete ; core/comment-date?: StylesPropertiesAndElementsComplete ; core/comment-edit-link?: StylesPropertiesAndElementsComplete ; core/comment-reply-link?: StylesPropertiesAndElementsComplete ; core/comment-template?: StylesPropertiesAndElementsComplete ; core/comments-query-loop?: StylesPropertiesAndElementsComplete ; core/cover?: StylesPropertiesAndElementsComplete ; core/embed?: StylesPropertiesAndElementsComplete ; core/file?: StylesPropertiesAndElementsComplete ; core/freeform?: StylesPropertiesAndElementsComplete ; core/gallery?: StylesPropertiesAndElementsComplete ; core/group?: StylesPropertiesAndElementsComplete ; core/heading?: StylesPropertiesAndElementsComplete ; core/home-link?: StylesPropertiesAndElementsComplete ; core/html?: StylesPropertiesAndElementsComplete ; core/image?: StylesPropertiesAndElementsComplete ; core/latest-comments?: StylesPropertiesAndElementsComplete ; core/latest-posts?: StylesPropertiesAndElementsComplete ; core/legacy-widget?: StylesPropertiesAndElementsComplete ; core/list?: StylesPropertiesAndElementsComplete ; core/loginout?: StylesPropertiesAndElementsComplete ; core/media-text?: StylesPropertiesAndElementsComplete ; core/missing?: StylesPropertiesAndElementsComplete ; core/more?: StylesPropertiesAndElementsComplete ; core/navigation?: StylesPropertiesAndElementsComplete ; core/navigation-link?: StylesPropertiesAndElementsComplete ; core/nextpage?: StylesPropertiesAndElementsComplete ; core/page-list?: StylesPropertiesAndElementsComplete ; core/paragraph?: StylesPropertiesAndElementsComplete ; core/post-author?: StylesPropertiesAndElementsComplete ; core/post-comments?: StylesPropertiesAndElementsComplete ; core/post-comments-count?: StylesPropertiesAndElementsComplete ; core/post-comments-form?: StylesPropertiesAndElementsComplete ; core/post-comments-link?: StylesPropertiesAndElementsComplete ; core/post-content?: StylesPropertiesAndElementsComplete ; core/post-date?: StylesPropertiesAndElementsComplete ; core/post-excerpt?: StylesPropertiesAndElementsComplete ; core/post-featured-image?: StylesPropertiesAndElementsComplete ; core/post-navigation-link?: StylesPropertiesAndElementsComplete ; core/post-template?: StylesPropertiesAndElementsComplete ; core/post-terms?: StylesPropertiesAndElementsComplete ; core/post-title?: StylesPropertiesAndElementsComplete ; core/preformatted?: StylesPropertiesAndElementsComplete ; core/pullquote?: StylesPropertiesAndElementsComplete ; core/query?: StylesPropertiesAndElementsComplete ; core/query-pagination?: StylesPropertiesAndElementsComplete ; core/query-pagination-next?: StylesPropertiesAndElementsComplete ; core/query-pagination-numbers?: StylesPropertiesAndElementsComplete ; core/query-pagination-previous?: StylesPropertiesAndElementsComplete ; core/query-title?: StylesPropertiesAndElementsComplete ; core/quote?: StylesPropertiesAndElementsComplete ; core/rss?: StylesPropertiesAndElementsComplete ; core/search?: StylesPropertiesAndElementsComplete ; core/separator?: StylesPropertiesAndElementsComplete ; core/shortcode?: StylesPropertiesAndElementsComplete ; core/site-logo?: StylesPropertiesAndElementsComplete ; core/site-tagline?: StylesPropertiesAndElementsComplete ; core/site-title?: StylesPropertiesAndElementsComplete ; core/social-link?: StylesPropertiesAndElementsComplete ; core/social-links?: StylesPropertiesAndElementsComplete ; core/spacer?: StylesPropertiesAndElementsComplete ; core/table?: StylesPropertiesAndElementsComplete ; core/table-of-contents?: StylesPropertiesAndElementsComplete ; core/tag-cloud?: StylesPropertiesAndElementsComplete ; core/template-part?: StylesPropertiesAndElementsComplete ; core/term-description?: StylesPropertiesAndElementsComplete ; core/text-columns?: StylesPropertiesAndElementsComplete ; core/verse?: StylesPropertiesAndElementsComplete ; core/video?: StylesPropertiesAndElementsComplete ; core/widget-area?: StylesPropertiesAndElementsComplete ; core/widget-group?: StylesPropertiesAndElementsComplete } ; border?: unknown ; color?: unknown ; elements?: { h1?: StylesPropertiesComplete ; h2?: StylesPropertiesComplete ; h3?: StylesPropertiesComplete ; h4?: StylesPropertiesComplete ; h5?: StylesPropertiesComplete ; h6?: StylesPropertiesComplete ; link?: StylesPropertiesComplete } ; spacing?: unknown ; typography?: unknown }

Organized way to set CSS properties. Styles in the top-level will be added in the body selector.

Defined in​

packages/core/src/react/provider/types.ts:210

templateParts​

• Optional templateParts: { area?: string ; name: string ; title?: string }[]

Additional metadata for template parts defined in the parts folder.

Defined in​

packages/core/src/react/provider/types.ts:336

version​

• version: 2

Version of theme.json to use.

Defined in​

packages/core/src/react/provider/types.ts:103

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: WpThemeJSON

@headstartwp/core.react.WpThemeJSON

Properties​

$schema​

• Optional $schema: string

JSON schema URI for theme.json.

Defined in​

packages/core/src/react/provider/types.ts:99

customTemplates​

• Optional customTemplates: { name: string ; postTypes?: string[] ; title: string }[]

Additional metadata for custom templates defined in the templates folder.

Defined in​

packages/core/src/react/provider/types.ts:319

settings​

• Optional settings: SettingsProperties & { blocks?: { core/archives?: SettingsPropertiesComplete ; core/audio?: SettingsPropertiesComplete ; core/block?: SettingsPropertiesComplete ; core/button?: SettingsPropertiesComplete ; core/buttons?: SettingsPropertiesComplete ; core/calendar?: SettingsPropertiesComplete ; core/categories?: SettingsPropertiesComplete ; core/code?: SettingsPropertiesComplete ; core/column?: SettingsPropertiesComplete ; core/columns?: SettingsPropertiesComplete ; core/comment-author-avatar?: SettingsPropertiesComplete ; core/comment-author-name?: SettingsPropertiesComplete ; core/comment-content?: SettingsPropertiesComplete ; core/comment-date?: SettingsPropertiesComplete ; core/comment-edit-link?: SettingsPropertiesComplete ; core/comment-reply-link?: SettingsPropertiesComplete ; core/comment-template?: SettingsPropertiesComplete ; core/comments-query-loop?: SettingsPropertiesComplete ; core/cover?: SettingsPropertiesComplete ; core/embed?: SettingsPropertiesComplete ; core/file?: SettingsPropertiesComplete ; core/freeform?: SettingsPropertiesComplete ; core/gallery?: SettingsPropertiesComplete ; core/group?: SettingsPropertiesComplete ; core/heading?: SettingsPropertiesComplete ; core/home-link?: SettingsPropertiesComplete ; core/html?: SettingsPropertiesComplete ; core/image?: SettingsPropertiesComplete ; core/latest-comments?: SettingsPropertiesComplete ; core/latest-posts?: SettingsPropertiesComplete ; core/legacy-widget?: SettingsPropertiesComplete ; core/list?: SettingsPropertiesComplete ; core/loginout?: SettingsPropertiesComplete ; core/media-text?: SettingsPropertiesComplete ; core/missing?: SettingsPropertiesComplete ; core/more?: SettingsPropertiesComplete ; core/navigation?: SettingsPropertiesComplete ; core/navigation-link?: SettingsPropertiesComplete ; core/nextpage?: SettingsPropertiesComplete ; core/page-list?: SettingsPropertiesComplete ; core/paragraph?: SettingsPropertiesComplete ; core/post-author?: SettingsPropertiesComplete ; core/post-comments?: SettingsPropertiesComplete ; core/post-comments-count?: SettingsPropertiesComplete ; core/post-comments-form?: SettingsPropertiesComplete ; core/post-comments-link?: SettingsPropertiesComplete ; core/post-content?: SettingsPropertiesComplete ; core/post-date?: SettingsPropertiesComplete ; core/post-excerpt?: SettingsPropertiesComplete ; core/post-featured-image?: SettingsPropertiesComplete ; core/post-navigation-link?: SettingsPropertiesComplete ; core/post-template?: SettingsPropertiesComplete ; core/post-terms?: SettingsPropertiesComplete ; core/post-title?: SettingsPropertiesComplete ; core/preformatted?: SettingsPropertiesComplete ; core/pullquote?: SettingsPropertiesComplete ; core/query?: SettingsPropertiesComplete ; core/query-pagination?: SettingsPropertiesComplete ; core/query-pagination-next?: SettingsPropertiesComplete ; core/query-pagination-numbers?: SettingsPropertiesComplete ; core/query-pagination-previous?: SettingsPropertiesComplete ; core/query-title?: SettingsPropertiesComplete ; core/quote?: SettingsPropertiesComplete ; core/rss?: SettingsPropertiesComplete ; core/search?: SettingsPropertiesComplete ; core/separator?: SettingsPropertiesComplete ; core/shortcode?: SettingsPropertiesComplete ; core/site-logo?: SettingsPropertiesComplete ; core/site-tagline?: SettingsPropertiesComplete ; core/site-title?: SettingsPropertiesComplete ; core/social-link?: SettingsPropertiesComplete ; core/social-links?: SettingsPropertiesComplete ; core/spacer?: SettingsPropertiesComplete ; core/table?: SettingsPropertiesComplete ; core/table-of-contents?: SettingsPropertiesComplete ; core/tag-cloud?: SettingsPropertiesComplete ; core/template-part?: SettingsPropertiesComplete ; core/term-description?: SettingsPropertiesComplete ; core/text-columns?: SettingsPropertiesComplete ; core/verse?: SettingsPropertiesComplete ; core/video?: SettingsPropertiesComplete ; core/widget-area?: SettingsPropertiesComplete ; core/widget-group?: SettingsPropertiesComplete } ; border?: { color?: boolean ; radius?: boolean ; style?: boolean ; width?: boolean } ; color?: { background?: boolean ; custom?: boolean ; customDuotone?: boolean ; customGradient?: boolean ; defaultGradients?: boolean ; defaultPalette?: boolean ; duotone?: SettingsDuotone ; gradients?: SettingsGradient ; link?: boolean ; palette?: SettingsColorPalette ; text?: boolean } ; custom?: { [k: string]: string | number | SettingsCustomAdditionalProperties; } ; layout?: { contentSize?: string ; wideSize?: string } ; spacing?: { blockGap?: null | boolean ; margin?: boolean ; padding?: boolean ; units?: string[] } ; typography?: { customFontSize?: boolean ; dropCap?: boolean ; fontFamilies?: { fontFamily?: string ; name?: string ; slug?: string }[] ; fontSizes?: { name?: string ; size?: string ; slug?: string }[] ; fontStyle?: boolean ; fontWeight?: boolean ; letterSpacing?: boolean ; lineHeight?: boolean ; textDecoration?: boolean ; textTransform?: boolean } }

Settings for the block editor and individual blocks. These include things like:

  • Which customization options should be available to the user.
  • The default colors, font sizes... available to the user.
  • CSS custom properties and class names used in styles.
  • And the default layout of the editor (widths and available alignments).

Defined in​

packages/core/src/react/provider/types.ts:111

styles​

• Optional styles: StylesProperties & { blocks?: { core/archives?: StylesPropertiesAndElementsComplete ; core/audio?: StylesPropertiesAndElementsComplete ; core/block?: StylesPropertiesAndElementsComplete ; core/button?: StylesPropertiesAndElementsComplete ; core/buttons?: StylesPropertiesAndElementsComplete ; core/calendar?: StylesPropertiesAndElementsComplete ; core/categories?: StylesPropertiesAndElementsComplete ; core/code?: StylesPropertiesAndElementsComplete ; core/column?: StylesPropertiesAndElementsComplete ; core/columns?: StylesPropertiesAndElementsComplete ; core/comment-author-avatar?: StylesPropertiesAndElementsComplete ; core/comment-author-name?: StylesPropertiesAndElementsComplete ; core/comment-content?: StylesPropertiesAndElementsComplete ; core/comment-date?: StylesPropertiesAndElementsComplete ; core/comment-edit-link?: StylesPropertiesAndElementsComplete ; core/comment-reply-link?: StylesPropertiesAndElementsComplete ; core/comment-template?: StylesPropertiesAndElementsComplete ; core/comments-query-loop?: StylesPropertiesAndElementsComplete ; core/cover?: StylesPropertiesAndElementsComplete ; core/embed?: StylesPropertiesAndElementsComplete ; core/file?: StylesPropertiesAndElementsComplete ; core/freeform?: StylesPropertiesAndElementsComplete ; core/gallery?: StylesPropertiesAndElementsComplete ; core/group?: StylesPropertiesAndElementsComplete ; core/heading?: StylesPropertiesAndElementsComplete ; core/home-link?: StylesPropertiesAndElementsComplete ; core/html?: StylesPropertiesAndElementsComplete ; core/image?: StylesPropertiesAndElementsComplete ; core/latest-comments?: StylesPropertiesAndElementsComplete ; core/latest-posts?: StylesPropertiesAndElementsComplete ; core/legacy-widget?: StylesPropertiesAndElementsComplete ; core/list?: StylesPropertiesAndElementsComplete ; core/loginout?: StylesPropertiesAndElementsComplete ; core/media-text?: StylesPropertiesAndElementsComplete ; core/missing?: StylesPropertiesAndElementsComplete ; core/more?: StylesPropertiesAndElementsComplete ; core/navigation?: StylesPropertiesAndElementsComplete ; core/navigation-link?: StylesPropertiesAndElementsComplete ; core/nextpage?: StylesPropertiesAndElementsComplete ; core/page-list?: StylesPropertiesAndElementsComplete ; core/paragraph?: StylesPropertiesAndElementsComplete ; core/post-author?: StylesPropertiesAndElementsComplete ; core/post-comments?: StylesPropertiesAndElementsComplete ; core/post-comments-count?: StylesPropertiesAndElementsComplete ; core/post-comments-form?: StylesPropertiesAndElementsComplete ; core/post-comments-link?: StylesPropertiesAndElementsComplete ; core/post-content?: StylesPropertiesAndElementsComplete ; core/post-date?: StylesPropertiesAndElementsComplete ; core/post-excerpt?: StylesPropertiesAndElementsComplete ; core/post-featured-image?: StylesPropertiesAndElementsComplete ; core/post-navigation-link?: StylesPropertiesAndElementsComplete ; core/post-template?: StylesPropertiesAndElementsComplete ; core/post-terms?: StylesPropertiesAndElementsComplete ; core/post-title?: StylesPropertiesAndElementsComplete ; core/preformatted?: StylesPropertiesAndElementsComplete ; core/pullquote?: StylesPropertiesAndElementsComplete ; core/query?: StylesPropertiesAndElementsComplete ; core/query-pagination?: StylesPropertiesAndElementsComplete ; core/query-pagination-next?: StylesPropertiesAndElementsComplete ; core/query-pagination-numbers?: StylesPropertiesAndElementsComplete ; core/query-pagination-previous?: StylesPropertiesAndElementsComplete ; core/query-title?: StylesPropertiesAndElementsComplete ; core/quote?: StylesPropertiesAndElementsComplete ; core/rss?: StylesPropertiesAndElementsComplete ; core/search?: StylesPropertiesAndElementsComplete ; core/separator?: StylesPropertiesAndElementsComplete ; core/shortcode?: StylesPropertiesAndElementsComplete ; core/site-logo?: StylesPropertiesAndElementsComplete ; core/site-tagline?: StylesPropertiesAndElementsComplete ; core/site-title?: StylesPropertiesAndElementsComplete ; core/social-link?: StylesPropertiesAndElementsComplete ; core/social-links?: StylesPropertiesAndElementsComplete ; core/spacer?: StylesPropertiesAndElementsComplete ; core/table?: StylesPropertiesAndElementsComplete ; core/table-of-contents?: StylesPropertiesAndElementsComplete ; core/tag-cloud?: StylesPropertiesAndElementsComplete ; core/template-part?: StylesPropertiesAndElementsComplete ; core/term-description?: StylesPropertiesAndElementsComplete ; core/text-columns?: StylesPropertiesAndElementsComplete ; core/verse?: StylesPropertiesAndElementsComplete ; core/video?: StylesPropertiesAndElementsComplete ; core/widget-area?: StylesPropertiesAndElementsComplete ; core/widget-group?: StylesPropertiesAndElementsComplete } ; border?: unknown ; color?: unknown ; elements?: { h1?: StylesPropertiesComplete ; h2?: StylesPropertiesComplete ; h3?: StylesPropertiesComplete ; h4?: StylesPropertiesComplete ; h5?: StylesPropertiesComplete ; h6?: StylesPropertiesComplete ; link?: StylesPropertiesComplete } ; spacing?: unknown ; typography?: unknown }

Organized way to set CSS properties. Styles in the top-level will be added in the body selector.

Defined in​

packages/core/src/react/provider/types.ts:210

templateParts​

• Optional templateParts: { area?: string ; name: string ; title?: string }[]

Additional metadata for template parts defined in the parts folder.

Defined in​

packages/core/src/react/provider/types.ts:336

version​

• version: 2

Version of theme.json to use.

Defined in​

packages/core/src/react/provider/types.ts:103

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps/index.html b/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps/index.html index 0a784f136..f7096fe35 100644 --- a/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps/index.html +++ b/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: YoutubeLiteBlockProps

@headstartwp/core.react.YoutubeLiteBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

src​

• src: string

Defined in​

packages/core/src/react/blocks/YoutubeLiteBlock.tsx:29

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

title​

• title: string

Defined in​

packages/core/src/react/blocks/YoutubeLiteBlock.tsx:30

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: YoutubeLiteBlockProps

@headstartwp/core.react.YoutubeLiteBlockProps

Hierarchy​

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/src/react/blocks/types.ts:79

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/src/react/blocks/types.ts:77

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/src/react/blocks/types.ts:73

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/src/react/blocks/types.ts:75

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/src/react/blocks/types.ts:76

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/src/react/blocks/types.ts:72

src​

• src: string

Defined in​

packages/core/src/react/blocks/YoutubeLiteBlock.tsx:29

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/src/react/blocks/types.ts:74

title​

• title: string

Defined in​

packages/core/src/react/blocks/YoutubeLiteBlock.tsx:30

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.useAppSettingsResponse/index.html b/api/interfaces/headstartwp_core.react.useAppSettingsResponse/index.html index a46645124..d82ff3d5d 100644 --- a/api/interfaces/headstartwp_core.react.useAppSettingsResponse/index.html +++ b/api/interfaces/headstartwp_core.react.useAppSettingsResponse/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: useAppSettingsResponse<T>

@headstartwp/core.react.useAppSettingsResponse

Type parameters​

NameType
Textends AppEntity

Hierarchy​

Properties​

data​

• Optional data: T

Overrides​

HookResponse.data

Defined in​

packages/core/src/react/hooks/useFetchAppSettings.ts:8

error​

• Optional error: string

Inherited from​

HookResponse.error

Defined in​

packages/core/src/react/hooks/types.ts:6

isMainQuery​

• isMainQuery: boolean

Inherited from​

HookResponse.isMainQuery

Defined in​

packages/core/src/react/hooks/types.ts:8

loading​

• loading: boolean

Inherited from​

HookResponse.loading

Defined in​

packages/core/src/react/hooks/types.ts:7

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: useAppSettingsResponse<T>

@headstartwp/core.react.useAppSettingsResponse

Type parameters​

NameType
Textends AppEntity

Hierarchy​

Properties​

data​

• Optional data: T

Overrides​

HookResponse.data

Defined in​

packages/core/src/react/hooks/useFetchAppSettings.ts:9

error​

• Optional error: string

Inherited from​

HookResponse.error

Defined in​

packages/core/src/react/hooks/types.ts:6

isMainQuery​

• isMainQuery: boolean

Inherited from​

HookResponse.isMainQuery

Defined in​

packages/core/src/react/hooks/types.ts:8

loading​

• loading: boolean

Inherited from​

HookResponse.loading

Defined in​

packages/core/src/react/hooks/types.ts:7

mutate​

• mutate: KeyedMutator<FetchResponse<T>>

Defined in​

packages/core/src/react/hooks/useFetchAppSettings.ts:10

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.useFetchOptions/index.html b/api/interfaces/headstartwp_core.react.useFetchOptions/index.html index 250954bf2..cf3e674eb 100644 --- a/api/interfaces/headstartwp_core.react.useFetchOptions/index.html +++ b/api/interfaces/headstartwp_core.react.useFetchOptions/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content
Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content
Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.useMenuResponse/index.html b/api/interfaces/headstartwp_core.react.useMenuResponse/index.html index e2b307d73..c88c39f0a 100644 --- a/api/interfaces/headstartwp_core.react.useMenuResponse/index.html +++ b/api/interfaces/headstartwp_core.react.useMenuResponse/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: useMenuResponse

@headstartwp/core.react.useMenuResponse

Hierarchy​

Properties​

data​

• Optional data: MenuItemEntity[]

Overrides​

HookResponse.data

Defined in​

packages/core/src/react/hooks/useFetchMenu.ts:7

error​

• Optional error: string

Inherited from​

HookResponse.error

Defined in​

packages/core/src/react/hooks/types.ts:6

isMainQuery​

• isMainQuery: boolean

Inherited from​

HookResponse.isMainQuery

Defined in​

packages/core/src/react/hooks/types.ts:8

loading​

• loading: boolean

Inherited from​

HookResponse.loading

Defined in​

packages/core/src/react/hooks/types.ts:7

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: useMenuResponse

@headstartwp/core.react.useMenuResponse

Hierarchy​

Properties​

data​

• Optional data: MenuItemEntity[]

Overrides​

HookResponse.data

Defined in​

packages/core/src/react/hooks/useFetchMenu.ts:7

error​

• Optional error: string

Inherited from​

HookResponse.error

Defined in​

packages/core/src/react/hooks/types.ts:6

isMainQuery​

• isMainQuery: boolean

Inherited from​

HookResponse.isMainQuery

Defined in​

packages/core/src/react/hooks/types.ts:8

loading​

• loading: boolean

Inherited from​

HookResponse.loading

Defined in​

packages/core/src/react/hooks/types.ts:7

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.usePostOrPostResponse/index.html b/api/interfaces/headstartwp_core.react.usePostOrPostResponse/index.html index faf0f09a7..71b16896a 100644 --- a/api/interfaces/headstartwp_core.react.usePostOrPostResponse/index.html +++ b/api/interfaces/headstartwp_core.react.usePostOrPostResponse/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: usePostOrPostResponse<T>

@headstartwp/core.react.usePostOrPostResponse

Type parameters​

NameType
Textends PostEntity = PostEntity

Hierarchy​

Properties​

data​

• Optional data: Object

Type declaration​

NameType
post?T
posts?T[]

Overrides​

HookResponse.data

Defined in​

packages/core/src/react/hooks/useFetchPostOrPosts.ts:15

error​

• Optional error: string

Inherited from​

HookResponse.error

Defined in​

packages/core/src/react/hooks/types.ts:6

isArchive​

• isArchive: boolean

Defined in​

packages/core/src/react/hooks/useFetchPostOrPosts.ts:17

isMainQuery​

• isMainQuery: boolean

Inherited from​

HookResponse.isMainQuery

Defined in​

packages/core/src/react/hooks/types.ts:8

isSingle​

• isSingle: boolean

Defined in​

packages/core/src/react/hooks/useFetchPostOrPosts.ts:16

loading​

• loading: boolean

Inherited from​

HookResponse.loading

Defined in​

packages/core/src/react/hooks/types.ts:7

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: usePostOrPostResponse<T>

@headstartwp/core.react.usePostOrPostResponse

Type parameters​

NameType
Textends PostEntity = PostEntity

Hierarchy​

Properties​

data​

• Optional data: Object

Type declaration​

NameType
post?T
posts?T[]

Overrides​

HookResponse.data

Defined in​

packages/core/src/react/hooks/useFetchPostOrPosts.ts:15

error​

• Optional error: string

Inherited from​

HookResponse.error

Defined in​

packages/core/src/react/hooks/types.ts:6

isArchive​

• isArchive: boolean

Defined in​

packages/core/src/react/hooks/useFetchPostOrPosts.ts:17

isMainQuery​

• isMainQuery: boolean

Inherited from​

HookResponse.isMainQuery

Defined in​

packages/core/src/react/hooks/types.ts:8

isSingle​

• isSingle: boolean

Defined in​

packages/core/src/react/hooks/useFetchPostOrPosts.ts:16

loading​

• loading: boolean

Inherited from​

HookResponse.loading

Defined in​

packages/core/src/react/hooks/types.ts:7

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.usePostResponse/index.html b/api/interfaces/headstartwp_core.react.usePostResponse/index.html index a620f784a..9ba168c5c 100644 --- a/api/interfaces/headstartwp_core.react.usePostResponse/index.html +++ b/api/interfaces/headstartwp_core.react.usePostResponse/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: usePostResponse<T>

@headstartwp/core.react.usePostResponse

Type parameters​

NameType
Textends PostEntity = PostEntity

Hierarchy​

Properties​

data​

• Optional data: Object

Type declaration​

NameType
postT

Overrides​

HookResponse.data

Defined in​

packages/core/src/react/hooks/useFetchPost.ts:15

error​

• Optional error: string

Inherited from​

HookResponse.error

Defined in​

packages/core/src/react/hooks/types.ts:6

isMainQuery​

• isMainQuery: boolean

Inherited from​

HookResponse.isMainQuery

Defined in​

packages/core/src/react/hooks/types.ts:8

loading​

• loading: boolean

Inherited from​

HookResponse.loading

Defined in​

packages/core/src/react/hooks/types.ts:7

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: usePostResponse<T>

@headstartwp/core.react.usePostResponse

Type parameters​

NameType
Textends PostEntity = PostEntity

Hierarchy​

Properties​

data​

• Optional data: Object

Type declaration​

NameType
pageInfoPageInfo
postT
queriedObjectQueriedObject

Overrides​

HookResponse.data

Defined in​

packages/core/src/react/hooks/useFetchPost.ts:16

error​

• Optional error: string

Inherited from​

HookResponse.error

Defined in​

packages/core/src/react/hooks/types.ts:6

isMainQuery​

• isMainQuery: boolean

Inherited from​

HookResponse.isMainQuery

Defined in​

packages/core/src/react/hooks/types.ts:8

loading​

• loading: boolean

Inherited from​

HookResponse.loading

Defined in​

packages/core/src/react/hooks/types.ts:7

mutate​

• mutate: KeyedMutator<FetchResponse<T>>

Defined in​

packages/core/src/react/hooks/useFetchPost.ts:21

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.usePostsResponse/index.html b/api/interfaces/headstartwp_core.react.usePostsResponse/index.html index d0d0c92d4..422a71ede 100644 --- a/api/interfaces/headstartwp_core.react.usePostsResponse/index.html +++ b/api/interfaces/headstartwp_core.react.usePostsResponse/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: usePostsResponse<T>

@headstartwp/core.react.usePostsResponse

Type parameters​

NameType
Textends PostEntity = PostEntity

Hierarchy​

Properties​

data​

• Optional data: Object

Type declaration​

NameType
pageInfoPageInfo
postsT[]
queriedObjectQueriedObject

Overrides​

HookResponse.data

Defined in​

packages/core/src/react/hooks/useFetchPosts.ts:59

error​

• Optional error: string

Inherited from​

HookResponse.error

Defined in​

packages/core/src/react/hooks/types.ts:6

isMainQuery​

• isMainQuery: boolean

Inherited from​

HookResponse.isMainQuery

Defined in​

packages/core/src/react/hooks/types.ts:8

loading​

• loading: boolean

Inherited from​

HookResponse.loading

Defined in​

packages/core/src/react/hooks/types.ts:7

pageType​

• pageType: PageType

Defined in​

packages/core/src/react/hooks/useFetchPosts.ts:64

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: usePostsResponse<T>

@headstartwp/core.react.usePostsResponse

Type parameters​

NameType
Textends PostEntity = PostEntity

Hierarchy​

Properties​

data​

• Optional data: Object

Type declaration​

NameType
pageInfoPageInfo
postsT[]
queriedObjectQueriedObject

Overrides​

HookResponse.data

Defined in​

packages/core/src/react/hooks/useFetchPosts.ts:60

error​

• Optional error: string

Inherited from​

HookResponse.error

Defined in​

packages/core/src/react/hooks/types.ts:6

isMainQuery​

• isMainQuery: boolean

Inherited from​

HookResponse.isMainQuery

Defined in​

packages/core/src/react/hooks/types.ts:8

loading​

• loading: boolean

Inherited from​

HookResponse.loading

Defined in​

packages/core/src/react/hooks/types.ts:7

mutate​

• mutate: KeyedMutator<FetchResponse<T[]>>

Defined in​

packages/core/src/react/hooks/useFetchPosts.ts:66

pageType​

• pageType: PageType

Defined in​

packages/core/src/react/hooks/useFetchPosts.ts:65

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.useSearchNativeResponse/index.html b/api/interfaces/headstartwp_core.react.useSearchNativeResponse/index.html index 1fc480ca3..b1e95a2c5 100644 --- a/api/interfaces/headstartwp_core.react.useSearchNativeResponse/index.html +++ b/api/interfaces/headstartwp_core.react.useSearchNativeResponse/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: useSearchNativeResponse<T>

@headstartwp/core.react.useSearchNativeResponse

Type parameters​

NameType
Textends PostSearchEntity | TermSearchEntity = PostSearchEntity | TermSearchEntity

Hierarchy​

Properties​

data​

• Optional data: Object

Type declaration​

NameType
pageInfoPageInfo
queriedObjectQueriedObject
searchResultsT[]

Overrides​

HookResponse.data

Defined in​

packages/core/src/react/hooks/useFetchSearchNative.ts:21

error​

• Optional error: string

Inherited from​

HookResponse.error

Defined in​

packages/core/src/react/hooks/types.ts:6

isMainQuery​

• isMainQuery: boolean

Inherited from​

HookResponse.isMainQuery

Defined in​

packages/core/src/react/hooks/types.ts:8

loading​

• loading: boolean

Inherited from​

HookResponse.loading

Defined in​

packages/core/src/react/hooks/types.ts:7

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: useSearchNativeResponse<T>

@headstartwp/core.react.useSearchNativeResponse

Type parameters​

NameType
Textends PostSearchEntity | TermSearchEntity = PostSearchEntity | TermSearchEntity

Hierarchy​

Properties​

data​

• Optional data: Object

Type declaration​

NameType
pageInfoPageInfo
queriedObjectQueriedObject
searchResultsT[]

Overrides​

HookResponse.data

Defined in​

packages/core/src/react/hooks/useFetchSearchNative.ts:22

error​

• Optional error: string

Inherited from​

HookResponse.error

Defined in​

packages/core/src/react/hooks/types.ts:6

isMainQuery​

• isMainQuery: boolean

Inherited from​

HookResponse.isMainQuery

Defined in​

packages/core/src/react/hooks/types.ts:8

loading​

• loading: boolean

Inherited from​

HookResponse.loading

Defined in​

packages/core/src/react/hooks/types.ts:7

mutate​

• mutate: KeyedMutator<FetchResponse<T[]>>

Defined in​

packages/core/src/react/hooks/useFetchSearchNative.ts:23

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.useSearchResponse/index.html b/api/interfaces/headstartwp_core.react.useSearchResponse/index.html index 73e9370b4..9e3aeef86 100644 --- a/api/interfaces/headstartwp_core.react.useSearchResponse/index.html +++ b/api/interfaces/headstartwp_core.react.useSearchResponse/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: useSearchResponse<T>

@headstartwp/core.react.useSearchResponse

Type parameters​

NameType
Textends PostEntity = PostEntity

Hierarchy​

Properties​

data​

• Optional data: Object

Type declaration​

NameType
pageInfoPageInfo
postsT[]
queriedObjectQueriedObject

Overrides​

HookResponse.data

Defined in​

packages/core/src/react/hooks/useFetchSearch.ts:18

error​

• Optional error: string

Inherited from​

HookResponse.error

Defined in​

packages/core/src/react/hooks/types.ts:6

isMainQuery​

• isMainQuery: boolean

Inherited from​

HookResponse.isMainQuery

Defined in​

packages/core/src/react/hooks/types.ts:8

loading​

• loading: boolean

Inherited from​

HookResponse.loading

Defined in​

packages/core/src/react/hooks/types.ts:7

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: useSearchResponse<T>

@headstartwp/core.react.useSearchResponse

Type parameters​

NameType
Textends PostEntity = PostEntity

Hierarchy​

Properties​

data​

• Optional data: Object

Type declaration​

NameType
pageInfoPageInfo
postsT[]
queriedObjectQueriedObject

Overrides​

HookResponse.data

Defined in​

packages/core/src/react/hooks/useFetchSearch.ts:19

error​

• Optional error: string

Inherited from​

HookResponse.error

Defined in​

packages/core/src/react/hooks/types.ts:6

isMainQuery​

• isMainQuery: boolean

Inherited from​

HookResponse.isMainQuery

Defined in​

packages/core/src/react/hooks/types.ts:8

loading​

• loading: boolean

Inherited from​

HookResponse.loading

Defined in​

packages/core/src/react/hooks/types.ts:7

mutate​

• mutate: KeyedMutator<FetchResponse<T[]>>

Defined in​

packages/core/src/react/hooks/useFetchSearch.ts:20

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_core.react.useTermsResponse/index.html b/api/interfaces/headstartwp_core.react.useTermsResponse/index.html index 8738a38fb..65bdfc811 100644 --- a/api/interfaces/headstartwp_core.react.useTermsResponse/index.html +++ b/api/interfaces/headstartwp_core.react.useTermsResponse/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: useTermsResponse<T>

@headstartwp/core.react.useTermsResponse

Type parameters​

NameType
Textends TermEntity

Hierarchy​

Properties​

data​

• Optional data: Object

Type declaration​

NameType
pageInfoPageInfo
termsT[]

Overrides​

HookResponse.data

Defined in​

packages/core/src/react/hooks/useFetchTerms.ts:15

error​

• Optional error: string

Inherited from​

HookResponse.error

Defined in​

packages/core/src/react/hooks/types.ts:6

isMainQuery​

• isMainQuery: boolean

Inherited from​

HookResponse.isMainQuery

Defined in​

packages/core/src/react/hooks/types.ts:8

loading​

• loading: boolean

Inherited from​

HookResponse.loading

Defined in​

packages/core/src/react/hooks/types.ts:7

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: useTermsResponse<T>

@headstartwp/core.react.useTermsResponse

Type parameters​

NameType
Textends TermEntity

Hierarchy​

Properties​

data​

• Optional data: Object

Type declaration​

NameType
pageInfoPageInfo
termsT[]

Overrides​

HookResponse.data

Defined in​

packages/core/src/react/hooks/useFetchTerms.ts:16

error​

• Optional error: string

Inherited from​

HookResponse.error

Defined in​

packages/core/src/react/hooks/types.ts:6

isMainQuery​

• isMainQuery: boolean

Inherited from​

HookResponse.isMainQuery

Defined in​

packages/core/src/react/hooks/types.ts:8

loading​

• loading: boolean

Inherited from​

HookResponse.loading

Defined in​

packages/core/src/react/hooks/types.ts:7

mutate​

• mutate: KeyedMutator<FetchResponse<T[]>>

Defined in​

packages/core/src/react/hooks/useFetchTerms.ts:17

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_next.FetchHookDataOptions/index.html b/api/interfaces/headstartwp_next.FetchHookDataOptions/index.html index a668bec36..95deb6d40 100644 --- a/api/interfaces/headstartwp_next.FetchHookDataOptions/index.html +++ b/api/interfaces/headstartwp_next.FetchHookDataOptions/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: FetchHookDataOptions<P, T>

@headstartwp/next.FetchHookDataOptions

The supported options for fetchHookData

Type parameters​

NameType
Punknown
Tunknown

Properties​

fetchStrategyOptions​

• Optional fetchStrategyOptions: Partial<FetchOptions>

Optional. If set, will forward fetch options to the fetch strategy

Defined in​

packages/next/src/data/server/fetchHookData.ts:34

filterData​

• Optional filterData: FilterDataOptions<T>

Optional. If set, the data will be filtered given FilterDataOptions

Defined in​

packages/next/src/data/server/fetchHookData.ts:29

params​

• Optional params: P

This should match params passed to the hook on the client side.

Defined in​

packages/next/src/data/server/fetchHookData.ts:24

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: FetchHookDataOptions<P, T>

@headstartwp/next.FetchHookDataOptions

The supported options for fetchHookData

Type parameters​

NameType
Punknown
Tunknown

Properties​

fetchStrategyOptions​

• Optional fetchStrategyOptions: Partial<FetchOptions>

Optional. If set, will forward fetch options to the fetch strategy

Defined in​

packages/next/src/data/server/fetchHookData.ts:34

filterData​

• Optional filterData: FilterDataOptions<T>

Optional. If set, the data will be filtered given FilterDataOptions

Defined in​

packages/next/src/data/server/fetchHookData.ts:29

params​

• Optional params: P

This should match params passed to the hook on the client side.

Defined in​

packages/next/src/data/server/fetchHookData.ts:24

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_next.ImageProps/index.html b/api/interfaces/headstartwp_next.ImageProps/index.html index eeae8c05a..7e8cb727b 100644 --- a/api/interfaces/headstartwp_next.ImageProps/index.html +++ b/api/interfaces/headstartwp_next.ImageProps/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: ImageProps

@headstartwp/next.ImageProps

Hierarchy​

  • ImageBlockProps

    ↳ ImageProps

Properties​

alt​

• Optional alt: string

Inherited from​

ImageBlockProps.alt

Defined in​

packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:9

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

ImageBlockProps.attributes

Defined in​

packages/core/dist/mjs/react/blocks/types.d.ts:70

children​

• Optional children: ReactNode

Inherited from​

ImageBlockProps.children

Defined in​

packages/core/dist/mjs/react/blocks/types.d.ts:69

className​

• Optional className: string

Inherited from​

ImageBlockProps.className

Defined in​

packages/core/dist/mjs/react/blocks/types.d.ts:65

domNode​

• Optional domNode: Element

Inherited from​

ImageBlockProps.domNode

Defined in​

packages/core/dist/mjs/react/blocks/types.d.ts:67

height​

• Optional height: number

Inherited from​

ImageBlockProps.height

Defined in​

packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:5

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

ImageBlockProps.htmlAnchor

Defined in​

packages/core/dist/mjs/react/blocks/types.d.ts:68

linkDestination​

• Optional linkDestination: string

Inherited from​

ImageBlockProps.linkDestination

Defined in​

packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:7

loader​

• Optional loader: (props: ImageLoaderProps | VIPCustomImageLoader) => string

Type declaration​

▸ (props): string

Parameters​
NameType
propsImageLoaderProps | VIPCustomImageLoader
Returns​

string

Defined in​

packages/next/src/components/ImageComponent.tsx:75

name​

• name: string

Inherited from​

ImageBlockProps.name

Defined in​

packages/core/dist/mjs/react/blocks/types.d.ts:64

sizeSlug​

• Optional sizeSlug: string

Inherited from​

ImageBlockProps.sizeSlug

Defined in​

packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:6

src​

• src: string

Inherited from​

ImageBlockProps.src

Defined in​

packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:8

style​

• Optional style: Record<string, string>

Inherited from​

ImageBlockProps.style

Defined in​

packages/core/dist/mjs/react/blocks/types.d.ts:66

width​

• Optional width: number

Inherited from​

ImageBlockProps.width

Defined in​

packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:4

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: ImageProps

@headstartwp/next.ImageProps

Hierarchy​

  • ImageBlockProps

    ↳ ImageProps

Properties​

alt​

• Optional alt: string

Inherited from​

ImageBlockProps.alt

Defined in​

packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:9

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

ImageBlockProps.attributes

Defined in​

packages/core/dist/mjs/react/blocks/types.d.ts:70

children​

• Optional children: ReactNode

Inherited from​

ImageBlockProps.children

Defined in​

packages/core/dist/mjs/react/blocks/types.d.ts:69

className​

• Optional className: string

Inherited from​

ImageBlockProps.className

Defined in​

packages/core/dist/mjs/react/blocks/types.d.ts:65

domNode​

• Optional domNode: Element

Inherited from​

ImageBlockProps.domNode

Defined in​

packages/core/dist/mjs/react/blocks/types.d.ts:67

height​

• Optional height: number

Inherited from​

ImageBlockProps.height

Defined in​

packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:5

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

ImageBlockProps.htmlAnchor

Defined in​

packages/core/dist/mjs/react/blocks/types.d.ts:68

linkDestination​

• Optional linkDestination: string

Inherited from​

ImageBlockProps.linkDestination

Defined in​

packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:7

loader​

• Optional loader: (props: ImageLoaderProps | VIPCustomImageLoader) => string

Type declaration​

▸ (props): string

Parameters​
NameType
propsImageLoaderProps | VIPCustomImageLoader
Returns​

string

Defined in​

packages/next/src/components/ImageComponent.tsx:75

name​

• name: string

Inherited from​

ImageBlockProps.name

Defined in​

packages/core/dist/mjs/react/blocks/types.d.ts:64

sizeSlug​

• Optional sizeSlug: string

Inherited from​

ImageBlockProps.sizeSlug

Defined in​

packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:6

src​

• src: string

Inherited from​

ImageBlockProps.src

Defined in​

packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:8

style​

• Optional style: Record<string, string>

Inherited from​

ImageBlockProps.style

Defined in​

packages/core/dist/mjs/react/blocks/types.d.ts:66

width​

• Optional width: number

Inherited from​

ImageBlockProps.width

Defined in​

packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:4

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/interfaces/headstartwp_next.LinkBlockProps/index.html b/api/interfaces/headstartwp_next.LinkBlockProps/index.html index f0e601bdc..51ed16da1 100644 --- a/api/interfaces/headstartwp_next.LinkBlockProps/index.html +++ b/api/interfaces/headstartwp_next.LinkBlockProps/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Interface: LinkBlockProps

@headstartwp/next.LinkBlockProps

Hierarchy​

  • IBlockAttributes

    ↳ LinkBlockProps

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/dist/mjs/react/blocks/types.d.ts:70

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/dist/mjs/react/blocks/types.d.ts:69

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/dist/mjs/react/blocks/types.d.ts:65

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/dist/mjs/react/blocks/types.d.ts:67

href​

• href: string

Defined in​

packages/next/src/blocks/LinkBlock.tsx:7

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/dist/mjs/react/blocks/types.d.ts:68

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/dist/mjs/react/blocks/types.d.ts:64

rel​

• rel: string

Defined in​

packages/next/src/blocks/LinkBlock.tsx:8

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/dist/mjs/react/blocks/types.d.ts:66

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Interface: LinkBlockProps

@headstartwp/next.LinkBlockProps

Hierarchy​

  • IBlockAttributes

    ↳ LinkBlockProps

Properties​

attributes​

• Optional attributes: Object

Type declaration​

NameType
alignAlign
blockStyle?string
borderBorder
colorsColors
spacingSpacing
typographyTypography
width?string

Inherited from​

IBlockAttributes.attributes

Defined in​

packages/core/dist/mjs/react/blocks/types.d.ts:70

children​

• Optional children: ReactNode

Inherited from​

IBlockAttributes.children

Defined in​

packages/core/dist/mjs/react/blocks/types.d.ts:69

className​

• Optional className: string

Inherited from​

IBlockAttributes.className

Defined in​

packages/core/dist/mjs/react/blocks/types.d.ts:65

domNode​

• Optional domNode: Element

Inherited from​

IBlockAttributes.domNode

Defined in​

packages/core/dist/mjs/react/blocks/types.d.ts:67

href​

• href: string

Defined in​

packages/next/src/blocks/LinkBlock.tsx:7

htmlAnchor​

• Optional htmlAnchor: string

Inherited from​

IBlockAttributes.htmlAnchor

Defined in​

packages/core/dist/mjs/react/blocks/types.d.ts:68

name​

• name: string

Inherited from​

IBlockAttributes.name

Defined in​

packages/core/dist/mjs/react/blocks/types.d.ts:64

rel​

• rel: string

Defined in​

packages/next/src/blocks/LinkBlock.tsx:8

style​

• Optional style: Record<string, string>

Inherited from​

IBlockAttributes.style

Defined in​

packages/core/dist/mjs/react/blocks/types.d.ts:66

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/modules/headstartwp_core/index.html b/api/modules/headstartwp_core/index.html index 9c4a96275..64e4650e9 100644 --- a/api/modules/headstartwp_core/index.html +++ b/api/modules/headstartwp_core/index.html @@ -7,26 +7,26 @@ - - + +
Skip to main content

Module: @headstartwp/core

Namespaces​

Enumerations​

Classes​

Interfaces​

DOM Helpers​

isAnchorTag​

▸ isAnchorTag(node, options?, site?): node is Element

Checks if the provided node is an valid anchor tag

This function expects to be used with DOMNode objects from html-react-parser, which is -the underlying parser used by BlocksRenderer.

Usage​

import { isAnchorTag } from '@headstartwp/core';
import { LinkBlock } from '@10up/headless-next';

<BlocksRenderer html={html}>
    <LinkBlock test={(node) => isAnchorTag(node, { isInternalLink: true})} />
</BlocksRenderer>

Parameters​

NameTypeDefault valueDescription
nodeDOMNodeundefinedThe node to test
optionsisAnchorTagOptions{}Supported options
siteundefined | HeadlessConfigundefined

Returns​

node is Element

Whether it's an anchor tag according to the options passed

Defined in​

packages/core/src/dom/index.ts:77

isBlock​

▸ isBlock(node, _options): boolean

Tests a node by tagName and/or className

This function expects to be used with DOMNode objects from html-react-parser, which is -the underlying parser used by BlocksRenderer.

Usage​

import { isBlock } from '@headstartwp/core';

<BlocksRenderer html={html}>
    <MyCustomBlock
            test={(node) => isBlock(node, { tagName: 'div', classList: ['block-class-name'] })}
        />
</BlocksRenderer>

Parameters​

NameTypeDescription
nodeDOMNodeThe node to test
_optionsisBlockOptions

Returns​

boolean

true if the node passes the test

Defined in​

packages/core/src/dom/index.ts:278

isBlockByName​

▸ isBlockByName(node, name): boolean

Tests a node by block name. This requires the Headless WP Plugin to be installed.

The Headless WP Plugin will append data-wp-block-name and data-wp-block to every block, +the underlying parser used by BlocksRenderer.

Usage​

import { isAnchorTag } from '@headstartwp/core';
import { LinkBlock } from '@10up/headless-next';

<BlocksRenderer html={html}>
    <LinkBlock test={(node) => isAnchorTag(node, { isInternalLink: true})} />
</BlocksRenderer>

Parameters​

NameTypeDefault valueDescription
nodeDOMNodeundefinedThe node to test
optionsisAnchorTagOptions{}Supported options
siteundefined | HeadlessConfigundefined

Returns​

node is Element

Whether it's an anchor tag according to the options passed

Defined in​

packages/core/src/dom/index.ts:77

isBlock​

▸ isBlock(node, _options): boolean

Tests a node by tagName and/or className

This function expects to be used with DOMNode objects from html-react-parser, which is +the underlying parser used by BlocksRenderer.

Usage​

import { isBlock } from '@headstartwp/core';

<BlocksRenderer html={html}>
    <MyCustomBlock
            test={(node) => isBlock(node, { tagName: 'div', classList: ['block-class-name'] })}
        />
</BlocksRenderer>

Parameters​

NameTypeDescription
nodeDOMNodeThe node to test
_optionsisBlockOptions

Returns​

boolean

true if the node passes the test

Defined in​

packages/core/src/dom/index.ts:278

isBlockByName​

▸ isBlockByName(node, name): boolean

Tests a node by block name. This requires the Headless WP Plugin to be installed.

The Headless WP Plugin will append data-wp-block-name and data-wp-block to every block, this function relies on those attributes to determine if the node is a block.

This function expects to be used with DOMNode objects from html-react-parser, which is -the underlying parser used by BlocksRenderer.

Usage​

import { isBlockByName } from '@headstartwp/core';

<BlocksRenderer html={html}>
    <MyCustomBlock
            test={(node) => isBlock(node, 'core/paragraph')}
        />
</BlocksRenderer>

Parameters​

NameTypeDescription
nodeDOMNodeThe node to test
namestringThe block name

Returns​

boolean

true if the node passes the test

Defined in​

packages/core/src/dom/index.ts:334

isImageTag​

▸ isImageTag(node, options?): string | boolean

Checks if the provided node is an valid image tag

This function expects to be used with DOMNode objects from html-react-parser, which is -the underlying parser used by BlocksRenderer.

Usage​

import { isImageTag, ImageBlock } from '@headstartwp/core';
import { ImageComponent } from '@10up/headless-next';

<BlocksRenderer html={html}>
    <ImageBlock
            test={(node) => isImageTag(node, { hasDimensions: true})}
            component={ImageComponent}
        />
</BlocksRenderer>

Parameters​

NameTypeDescription
nodeDOMNodeThe node to test
optionsisImageTagOptionsSupported options.

Returns​

string | boolean

Whether it's an image tag or not according to the options passed

Defined in​

packages/core/src/dom/index.ts:141

isTwitterEmbed​

▸ isTwitterEmbed(node): boolean

Checks if the node is an twitter embed

This function expects to be used with DOMNode objects from html-react-parser, which is -the underlying parser used by BlocksRenderer.

Usage​

import { isTwitterEmbed } from '@headstartwp/core';

<BlocksRenderer html={html}>
    <MyTwitterBlock
            test={isTwitterEmbed}
        />
</BlocksRenderer>

Parameters​

NameTypeDescription
nodeDOMNodeThe node to test

Returns​

boolean

true if the node is a twitter embed

Defined in​

packages/core/src/dom/index.ts:227

isYoutubeEmbed​

▸ isYoutubeEmbed(node): boolean

Checks if the node is an youtube embed

This function expects to be used with DOMNode objects from html-react-parser, which is -the underlying parser used by BlocksRenderer.

Usage​

import { isYoutubeEmbed } from '@headstartwp/core';

<BlocksRenderer html={html}>
    <MyYoutubeBlock
            test={isYoutubeEmbed}
        />
</BlocksRenderer>

Parameters​

NameTypeDescription
nodeDOMNodeThe node to test

Returns​

boolean

true if the node is a youtube embed

Defined in​

packages/core/src/dom/index.ts:187

wpKsesPost​

▸ wpKsesPost(content, allowList?, options?): string

Sanitize HTML content by the wp_kses_post() requirements

Usage​

import { wpKsesPost } from '@headstartwp/core';
wpKsesPost(html);

See

https://codex.wordpress.org/Function_Reference/wp_kses_post

Parameters​

NameTypeDescription
contentstringThe content to sanitize.
allowList?IWhiteListOptional. The list of allowed HTML tags and attributes. If not set, the default allow list will be used.
options?IWpKsesPostOptionsOptional. IWpKsesPostOptions.

Returns​

string

Sanitized string of HTML.

Defined in​

packages/core/src/dom/wpKsesPost.ts:30

Data Fetching​

apiGet​

▸ apiGet(url, args?, burstCache?): Promise<{ headers: { [index: string]: any; } = receivedHeaders; json: any }>

Fetch Wrapper to handle GET requests.

Parameters​

NameTypeDefault valueDescription
urlstringundefinedThe URL where to make the request to
argsObject{}The arguments
burstCachebooleanfalseWhether it should burst cache

Returns​

Promise<{ headers: { [index: string]: any; } = receivedHeaders; json: any }>

Defined in​

packages/core/src/data/api/fetch-utils.ts:46

apiPost​

▸ apiPost(url, args?): Promise<any>

Fetch Wrapper to handle POST requests

Parameters​

NameTypeDescription
urlstringThe URL where to make the request to
argsObjectThe arguments

Returns​

Promise<any>

Defined in​

packages/core/src/data/api/fetch-utils.ts:17

Data Handling​

getPostAuthor​

▸ getPostAuthor(post): AuthorEntity[]

Returns the author object from the post object if it exists

Parameters​

NameTypeDescription
postPostEntity | PostSearchEntityThe Post object

Returns​

AuthorEntity[]

Defined in​

packages/core/src/data/utils/postHandling.ts:11

getPostTerms​

▸ getPostTerms(post): Record<string, TermEntity[]>

Returns the terms associated with the post

Parameters​

NameTypeDescription
postPostEntity | PostSearchEntityThe Post object

Returns​

Record<string, TermEntity[]>

Defined in​

packages/core/src/data/utils/postHandling.ts:22

Other​

CustomPostType​

Ƭ CustomPostType: Object

Type declaration​

NameTypeDescription
archive?string-
endpointstring-
matchSinglePath?booleanWhether this custom post type should match the archive path If set to true, then when querying a post type archive page such as /[post-type]/[post-name] the post.link property should match the current path. This will avoid matching nested posts/pages that doesn't exist for instance: /[post-type]/fake-parent-page/[post-name] will not match if this option is set to true even though post-name exists. It is strongly recommended to set this option to true, otherwise hierarchical post types (such as pages) will not work properly. Default true
single?string-
slugstring-

Defined in​

packages/core/src/types.ts:1

CustomPostTypes​

Ƭ CustomPostTypes: CustomPostType[]

Defined in​

packages/core/src/types.ts:21

CustomTaxonomies​

Ƭ CustomTaxonomies: CustomTaxonomy[]

Defined in​

packages/core/src/types.ts:43

CustomTaxonomy​

Ƭ CustomTaxonomy: Object

Type declaration​

NameTypeDescription
endpointstring-
matchArchivePath?booleanWhether this custom taxonomy should match the archive path If set to true, then when querying a taxonomy archive page such as /[taxonmy-slug]/[term-slug] the term.link property should match the current path. This will avoid matching nested categories that doesn't exist for instance: /[taxonmy-slug]/fake-parent-term/[term-slug] will not match if this option is set to true even though term-slug exists. Default false
restParam?string-
rewrite?string-
slugstring-

Defined in​

packages/core/src/types.ts:25

DOMNode​

Ƭ DOMNode: Comment | Element | Node | ProcessingInstruction | Text

Defined in​

node_modules/html-react-parser/index.d.ts:21

HTMLParser2Options​

Ƭ HTMLParser2Options: ParserOptions & DomHandlerOptions

Defined in​

node_modules/html-react-parser/index.d.ts:19

HeadlessConfig​

Ƭ HeadlessConfig: Object

Type declaration​

NameType
customPostTypes?CustomPostTypes | (defaultPostTypes: CustomPostTypes) => CustomPostTypes
customTaxonomies?CustomTaxonomies | (defaultTaxonomies: CustomTaxonomies) => CustomTaxonomies
debug?{ devMode?: boolean ; redirects?: boolean ; requests?: boolean }
debug.devMode?boolean
debug.redirects?boolean
debug.requests?boolean
host?string
hostUrl?string
integrations?Integrations
locale?string
preview?PreviewConfig
redirectStrategy?RedirectStrategy
sites?HeadlessConfig[]
sourceUrl?string
useWordPressPlugin?boolean

Defined in​

packages/core/src/types.ts:73

Integrations​

Ƭ Integrations: Object

Type declaration​

NameType
polylang?PolylangIntegration
yoastSEO?YoastSEOIntegration

Defined in​

packages/core/src/types.ts:53

Matcher​

Ƭ Matcher: Object

Type declaration​

NameType
namestring
patternstring
prioritynumber

Defined in​

packages/core/src/data/utils/matchers.ts:1

NormalizedDataForCache​

Ƭ NormalizedDataForCache<T, P>: Object

Type parameters​

Name
T
P

Type declaration​

NameType
additionalCacheObjects?NormalizedDataForCache<T, P>[]
dataFetchResponse<T>
key{ args: Partial<P> ; url: string }
key.argsPartial<P>
key.urlstring

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:97

PostOrPostsFetchStrategyResult​

Ƭ PostOrPostsFetchStrategyResult<T>: Object

Type parameters​

Name
T

Type declaration​

NameType
dataT | T[]
isArchiveboolean
isSingleboolean

Defined in​

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:42

PreviewConfig​

Ƭ PreviewConfig: Object

Type declaration​

NameTypeDescription
alternativeAuthorizationHeader?booleanFlag to enable using the alternative authorization header. This can be useful if you have separate JWT-based authentication on your project.
usePostLinkForRedirect?booleanIf enabled, it will use the post.link property of the REST response to redirect to the appropriate route for previewing

Defined in​

packages/core/src/types.ts:58

QueriedObject​

Ƭ QueriedObject: Object

The QueriedObject represents the object that the current requests is subjected to.

Querying by taxonomy and/or author will set the queried object.

Type declaration​

NameTypeDescription
author?AuthorEntityIf the request is an author query, this will be populated with the author object
search?SearchEntityIf the request is a search query, this will be populated with the search entity object
term?TermEntityIf the request is a term query, this will be populated with the term object

Defined in​

packages/core/src/data/types/entities.ts:765

Redirect​

Ƭ Redirect: Object

Type declaration​

NameType
IDnumber
enable_regexboolean
post_statusstring
redirect_fromstring
redirect_tostring
status_codenumber

Defined in​

packages/core/src/data/types/entities.ts:705

RedirectData​

Ƭ RedirectData: Object

Type declaration​

NameTypeDescription
locationstring | undefined | nullThe redirect new location will be null if no redirect is found
statusnumberThe status number of the redirect Will be 0 if the redirect is not found

Defined in​

packages/core/src/utils/fetchRedirect.ts:5

RedirectStrategy​

Ƭ RedirectStrategy: "404" | "none" | "always"

Defined in​

packages/core/src/types.ts:23

isAnchorTagOptions​

Ƭ isAnchorTagOptions: Object

Type declaration​

NameTypeDescription
isInternalLink?booleanIf true, will check if the anchor tag contains a valid internal link. if target="_blank" then this option is not taken into account

Defined in​

packages/core/src/dom/index.ts:5

isBlockOptions​

Ƭ isBlockOptions: Object

Type declaration​

NameTypeDescription
className?string | string[]A single or array of classNames to check for If an array of class names is passed, the block will be considered valid if all of the class names are found
tagName?stringThe tagName to check for

Defined in​

packages/core/src/dom/index.ts:238

isImageTagOptions​

Ƭ isImageTagOptions: Object

Type declaration​

NameTypeDescription
hasDimensions?booleanIf true, will check if the image tag contains width and height attributes

Defined in​

packages/core/src/dom/index.ts:107

removeSourceUrlType​

Ƭ removeSourceUrlType: Object

Type declaration​

NameTypeDescription
backendUrlstringThe backend url.
linkstringThe link url, possibly with the source url.
nonEmptyLink?booleanIf the removal of source url from link leads to a empty string, this setting control whether a '/' should be returned or the empty string
publicUrl?stringThe public url. Defaults to '/'.

Defined in​

packages/core/src/utils/removeSourceUrl.ts:3

authorArchivesMatchers​

• Const authorArchivesMatchers: Matcher[]

Defined in​

packages/core/src/data/utils/matchers.ts:43

endpoints​

• Const endpoints: Object

Type declaration​

NameType
appSettingsstring
categorystring
pagesstring
postsstring
searchstring
tagsstring
tokenVerifystring
yoaststring

Defined in​

packages/core/src/utils/endpoints.ts:1

ksesAllowedList​

• Const ksesAllowedList: IWhiteList

Default Allowed HTML Attributes

See

https://codex.wordpress.org/Function_Reference/wp_kses_post

Defined in​

packages/core/src/dom/wpKsesPost.ts:266

postMatchers​

• Const postMatchers: Matcher[]

Defined in​

packages/core/src/data/utils/matchers.ts:7

postsMatchers​

• Const postsMatchers: Matcher[]

Defined in​

packages/core/src/data/utils/matchers.ts:20

searchMatchers​

• Const searchMatchers: Matcher[]

Defined in​

packages/core/src/data/utils/matchers.ts:56

youtubeEmbedRegex​

• Const youtubeEmbedRegex: RegExp

Defined in​

packages/core/src/dom/index.ts:160

HTMLReactParser​

▸ HTMLReactParser(html, options?): ReturnType<typeof domToReact>

Converts HTML string to JSX element(s).

Parameters​

NameTypeDescription
htmlstringHTML string.
options?HTMLReactParserOptionsParser options.

Returns​

ReturnType<typeof domToReact>

  • JSX element(s), empty array, or string.

Defined in​

node_modules/html-react-parser/index.d.ts:51

addQueryArgs​

▸ addQueryArgs(url, args): string

Parameters​

NameType
urlstring
argsRecord<string, any>

Returns​

string

Defined in​

packages/core/src/utils/url.ts:167

asyncForEach​

▸ asyncForEach(array, callback): Promise<void>

Parameters​

NameType
arrayany[]
callback(el: any, index: number, array: any[]) => void

Returns​

Promise<void>

Defined in​

packages/core/src/utils/asyncForEach.ts:1

attributesToProps​

▸ attributesToProps(attributes, nodeName?): Props

Converts HTML/SVG DOM attributes to React props.

Parameters​

NameTypeDescription
attributesAttributesHTML/SVG DOM attributes.
nodeName?stringDOM node name.

Returns​

Props

  • React props.

Defined in​

node_modules/html-react-parser/lib/attributes-to-props.d.ts:17

buildQueryString​

▸ buildQueryString(data): string

Generates URL-encoded query string using input query data.

It is intended to behave equivalent as PHP's http_build_query, configured -with encoding type PHP_QUERY_RFC3986 (spaces as %20).

Example

const queryString = buildQueryString( {
   simple: 'is ok',
   arrays: [ 'are', 'fine', 'too' ],
   objects: {
      evenNested: {
         ok: 'yes',
      },
   },
} );
// "simple=is%20ok&arrays%5B0%5D=are&arrays%5B1%5D=fine&arrays%5B2%5D=too&objects%5BevenNested%5D%5Bok%5D=yes"

Parameters​

NameTypeDescription
dataRecord<string, any>Data to encode.

Returns​

string

Query string.

Defined in​

packages/core/src/utils/url.ts:129

decodeHtmlSpeciaChars​

▸ decodeHtmlSpeciaChars(text): string

Decodes HTML special chars entities

Parameters​

NameTypeDescription
textstringThe text we want to decode

Returns​

string

text with decoded html entities

Defined in​

packages/core/src/utils/decodeHtmlSpeciaChars.ts:8

domToReact​

▸ domToReact(nodes, options?): string | JSX.Element | JSX.Element[]

Converts DOM nodes to JSX element(s).

Parameters​

NameTypeDescription
nodesDOMNode[]DOM nodes.
options?HTMLReactParserOptionsParser options.

Returns​

string | JSX.Element | JSX.Element[]

  • JSX element(s).

Defined in​

node_modules/html-react-parser/lib/dom-to-react.d.ts:15

fetchRedirect​

▸ fetchRedirect(pathname, sourceUrl): Promise<RedirectData>

Fetches a redirect from the WordPress origin by making a HEAD request and checking the response

Parameters​

NameTypeDescription
pathnamestringThe path to the page to fetch the redirect for
sourceUrlstringThe source url

Returns​

Promise<RedirectData>

The redirect data

Defined in​

packages/core/src/utils/fetchRedirect.ts:51

getAuthHeader​

▸ getAuthHeader(): null

Returns​

null

Defined in​

packages/core/src/data/api/fetch-utils.ts:3

getCustomPostType​

▸ getCustomPostType(slug, sourceUrl?): undefined | CustomPostType

Returns a single post type by slug if defined

Parameters​

NameTypeDescription
slugstringpost type slug
sourceUrl?string

Returns​

undefined | CustomPostType

Defined in​

packages/core/src/utils/config.ts:251

getCustomPostTypes​

▸ getCustomPostTypes(sourceUrl?): CustomPostTypes

Returns the available post types

Parameters​

NameType
sourceUrl?string

Returns​

CustomPostTypes

Defined in​

packages/core/src/utils/config.ts:228

getCustomPostTypesSlugs​

▸ getCustomPostTypesSlugs(sourceUrl?): string[]

Returns the available post type slugs

Parameters​

NameType
sourceUrl?string

Returns​

string[]

Defined in​

packages/core/src/utils/config.ts:239

getCustomTaxonomies​

▸ getCustomTaxonomies(sourceUrl?): CustomTaxonomies

Returns the available taxonomies

Parameters​

NameType
sourceUrl?string

Returns​

CustomTaxonomies

Defined in​

packages/core/src/utils/config.ts:188

getCustomTaxonomy​

▸ getCustomTaxonomy(slug, sourceUrl?): undefined | CustomTaxonomy

Returns a single post type by slug if defined

Parameters​

NameTypeDescription
slugstringpost type slug
sourceUrl?string

Returns​

undefined | CustomTaxonomy

Defined in​

packages/core/src/utils/config.ts:217

getCustomTaxonomySlugs​

▸ getCustomTaxonomySlugs(sourceUrl?): string[]

Returns the available taxonomy slugs

Parameters​

NameType
sourceUrl?string

Returns​

string[]

Defined in​

packages/core/src/utils/config.ts:200

getHeadlessConfig​

▸ getHeadlessConfig(): Object

Returns the contents of headless.config.js

This function requires framework integration in order to work. The contents of headless.config.js -needs to be injected at build time into a global variable.

Make sure you are using one of the framework's integration (such as next) before using this function.

Returns​

Object

The contents of headless.config.js

NameType
customPostTypesCustomPostTypes
customTaxonomiesCustomTaxonomies
debugundefined | { devMode?: boolean ; redirects?: boolean ; requests?: boolean }
hostUrlstring
integrationsundefined | Integrations
previewundefined | PreviewConfig
redirectStrategyRedirectStrategy
sitesHeadlessConfig[]
sourceUrlundefined | string
useWordPressPluginboolean

Defined in​

packages/core/src/utils/config.ts:22

getHeadstartWPConfig​

▸ getHeadstartWPConfig(): Object

Returns the contents of headless.config.js

This function requires framework integration in order to work. The contents of headless.config.js -needs to be injected at build time into a global variable.

Make sure you are using one of the framework's integration (such as next) before using this function.

Returns​

Object

The contents of headless.config.js

NameType
customPostTypesCustomPostTypes
customTaxonomiesCustomTaxonomies
debugundefined | { devMode?: boolean ; redirects?: boolean ; requests?: boolean }
hostUrlstring
integrationsundefined | Integrations
previewundefined | PreviewConfig
redirectStrategyRedirectStrategy
sitesHeadlessConfig[]
sourceUrlundefined | string
useWordPressPluginboolean

Defined in​

packages/core/src/utils/config.ts:22

getHostUrl​

▸ getHostUrl(): string

Returns the WP URL based on the headless config

Returns​

string

Defined in​

packages/core/src/utils/config.ts:268

getQueryArgs​

▸ getQueryArgs(url): Record<string, any>

Returns an object of query arguments of the given URL. If the given URL is -invalid or has no querystring, an empty object is returned.

Example

const foo = getQueryArgs( 'https://wordpress.org?foo=bar&bar=baz' );
// { "foo": "bar", "bar": "baz" }

Parameters​

NameTypeDescription
urlstringURL.

Returns​

Record<string, any>

Query args object.

Defined in​

packages/core/src/utils/url.ts:78

getQueryString​

▸ getQueryString(url): any

Parameters​

NameType
urlstring

Returns​

any

Defined in​

packages/core/src/utils/url.ts:49

getSite​

▸ getSite(site?): HeadlessConfig

Get a config for a specific site

Parameters​

NameType
site?HeadlessConfig

Returns​

HeadlessConfig

Defined in​

packages/core/src/utils/config.ts:113

getSiteByHost​

▸ getSiteByHost(hostOrUrl, locale?): null | HeadlessConfig

Finds a site by host and optionally locale

Parameters​

NameTypeDescription
hostOrUrlstringThe hostname
locale?string

Returns​

null | HeadlessConfig

Defined in​

packages/core/src/utils/config.ts:138

getSiteBySourceUrl​

▸ getSiteBySourceUrl(sourceUrl): HeadlessConfig

Get a site by source url

Parameters​

NameType
sourceUrlstring

Returns​

HeadlessConfig

HeadlessConfig

Defined in​

packages/core/src/utils/config.ts:176

getWPUrl​

▸ getWPUrl(): string

Returns the WP URL based on the headless config

Returns​

string

Defined in​

packages/core/src/utils/config.ts:260

htmlToDOM​

▸ htmlToDOM(html, options?): (Comment | Element | ProcessingInstruction | Text)[]

Parses HTML string to DOM nodes in Node.js.

This is the same method as require('htmlparser2').parseDOM -https://github.com/fb55/htmlparser2/blob/v6.0.0/src/index.ts#L29-L41

Parameters​

NameTypeDescription
htmlstringHTML markup.
options?DomHandlerOptionsParser options (https://github.com/fb55/domhandler/tree/v5.0.3#readme).

Returns​

(Comment | Element | ProcessingInstruction | Text)[]

  • DOM nodes.

Defined in​

node_modules/html-dom-parser/lib/server/html-to-dom.d.ts:21

isElement​

▸ isElement(node): node is Element

Checks if the node is an Element.

We rely on this function to avoid issues with instanceof.

See

https://github.com/10up/headstartwp/issues/504

Parameters​

NameTypeDescription
nodeDOMNodeThe dom node

Returns​

node is Element

Whether the node is of type element or not

Defined in​

packages/core/src/dom/index.ts:25

isExternalUrl​

▸ isExternalUrl(link): boolean

Checks if the provided link is an external Url.

Inspired on the Frontity implementation

See

https://github.com/frontity/frontity/blob/dev/packages/components/link/utils.ts

Parameters​

NameTypeDescription
linkstringThe link Url.

Returns​

boolean

True if the link is an external Url.

Defined in​

packages/core/src/utils/isExternalUrl.ts:12

▸ isInternalLink(url, site?): boolean

Checks if the url is for an internal link

Parameters​

NameTypeDescription
urlstringThe url to check
site?HeadlessConfig(optional) the site config

Returns​

boolean

Defined in​

packages/core/src/utils/isInternalLink.ts:14

log​

▸ log(type, ...args): void

Parameters​

NameType
typeLOGTYPE
...argsany[]

Returns​

void

Defined in​

packages/core/src/utils/log.ts:9

removeFieldsFromPostRelatedData​

▸ removeFieldsFromPostRelatedData(fieldsToRemove, post): PostEntity | { _embedded: { author: AuthorEntity[] ; wp:featuredmedia: any ; wp:term: TermEntity[][] } ; author?: AuthorEntity[] ; categories?: number[] ; comment_status?: "open" | "closed" ; content: Rendered ; date: string ; date_gmt: string ; excerpt: Rendered ; featured_media: number ; format: "link" | "status" | "standard" | "aside" | "chat" | "gallery" | "image" | "quote" | "video" | "audio" ; guid: Rendered ; id: number ; link: string ; meta: Record<string, unknown> ; modified: string ; modified_gmt: string ; ping_status: "open" | "closed" ; slug: string ; status: "publish" | "future" | "draft" | "pending" | "private" ; sticky: boolean ; tags?: number[] ; template: string ; terms?: Record<string, TermEntity[]> ; title: Rendered ; type: string ; yoast_head?: null | string ; yoast_head_json?: null | Record<string, any> }

Parameters​

NameType
fieldsToRemove(string | number)[]
postPostEntity

Returns​

PostEntity | { _embedded: { author: AuthorEntity[] ; wp:featuredmedia: any ; wp:term: TermEntity[][] } ; author?: AuthorEntity[] ; categories?: number[] ; comment_status?: "open" | "closed" ; content: Rendered ; date: string ; date_gmt: string ; excerpt: Rendered ; featured_media: number ; format: "link" | "status" | "standard" | "aside" | "chat" | "gallery" | "image" | "quote" | "video" | "audio" ; guid: Rendered ; id: number ; link: string ; meta: Record<string, unknown> ; modified: string ; modified_gmt: string ; ping_status: "open" | "closed" ; slug: string ; status: "publish" | "future" | "draft" | "pending" | "private" ; sticky: boolean ; tags?: number[] ; template: string ; terms?: Record<string, TermEntity[]> ; title: Rendered ; type: string ; yoast_head?: null | string ; yoast_head_json?: null | Record<string, any> }

Defined in​

packages/core/src/data/utils/postHandling.ts:51

removeSourceUrl​

▸ removeSourceUrl(«destructured»): string

Make the link relative if it belongs to the backend, to force client-side -navigation.

Inspired on the Frontity implementation

See

https://github.com/frontity/frontity/blob/dev/packages/components/link/utils.ts

Parameters​

NameType
«destructured»removeSourceUrlType

Returns​

string

The URL without the Source URL.

Defined in​

packages/core/src/utils/removeSourceUrl.ts:42

setHeadlessConfig​

▸ setHeadlessConfig(config): void

Parameters​

NameType
configHeadlessConfig

Returns​

void

Defined in​

packages/core/src/utils/config.ts:6

setHeadstartWPConfig​

▸ setHeadstartWPConfig(config): void

Parameters​

NameType
configHeadlessConfig

Returns​

void

Defined in​

packages/core/src/utils/config.ts:6

stripTags​

▸ stripTags(html): any

Utility functions to strip any tags

Parameters​

NameTypeDescription
htmlanyThe html string

Returns​

any

Defined in​

packages/core/src/dom/stripTags.ts:8

warn​

▸ warn(message): void

Logs a warning in the console in dev mode

Example

warn("You should do/change something.")

Parameters​

NameTypeDescription
messagestringThe message that describes the warning.

Returns​

void

Defined in​

packages/core/src/utils/errors.ts:45

Utility Functions​

parsePath​

▸ parsePath(matchers, path): Record<string, string>

Parses a path and extracts the parameters from it

Parameters​

NameTypeDescription
matchersMatcher[]An array of Matchers
pathstringThe path

Returns​

Record<string, string>

the extracted parameters

Defined in​

packages/core/src/data/utils/parsePath.ts:46

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +the underlying parser used by BlocksRenderer.

Usage​

import { isBlockByName } from '@headstartwp/core';

<BlocksRenderer html={html}>
    <MyCustomBlock
            test={(node) => isBlock(node, 'core/paragraph')}
        />
</BlocksRenderer>

Parameters​

NameTypeDescription
nodeDOMNodeThe node to test
namestringThe block name

Returns​

boolean

true if the node passes the test

Defined in​

packages/core/src/dom/index.ts:334

isImageTag​

▸ isImageTag(node, options?): string | boolean

Checks if the provided node is an valid image tag

This function expects to be used with DOMNode objects from html-react-parser, which is +the underlying parser used by BlocksRenderer.

Usage​

import { isImageTag, ImageBlock } from '@headstartwp/core';
import { ImageComponent } from '@10up/headless-next';

<BlocksRenderer html={html}>
    <ImageBlock
            test={(node) => isImageTag(node, { hasDimensions: true})}
            component={ImageComponent}
        />
</BlocksRenderer>

Parameters​

NameTypeDescription
nodeDOMNodeThe node to test
optionsisImageTagOptionsSupported options.

Returns​

string | boolean

Whether it's an image tag or not according to the options passed

Defined in​

packages/core/src/dom/index.ts:141

isTwitterEmbed​

▸ isTwitterEmbed(node): boolean

Checks if the node is an twitter embed

This function expects to be used with DOMNode objects from html-react-parser, which is +the underlying parser used by BlocksRenderer.

Usage​

import { isTwitterEmbed } from '@headstartwp/core';

<BlocksRenderer html={html}>
    <MyTwitterBlock
            test={isTwitterEmbed}
        />
</BlocksRenderer>

Parameters​

NameTypeDescription
nodeDOMNodeThe node to test

Returns​

boolean

true if the node is a twitter embed

Defined in​

packages/core/src/dom/index.ts:227

isYoutubeEmbed​

▸ isYoutubeEmbed(node): boolean

Checks if the node is an youtube embed

This function expects to be used with DOMNode objects from html-react-parser, which is +the underlying parser used by BlocksRenderer.

Usage​

import { isYoutubeEmbed } from '@headstartwp/core';

<BlocksRenderer html={html}>
    <MyYoutubeBlock
            test={isYoutubeEmbed}
        />
</BlocksRenderer>

Parameters​

NameTypeDescription
nodeDOMNodeThe node to test

Returns​

boolean

true if the node is a youtube embed

Defined in​

packages/core/src/dom/index.ts:187

wpKsesPost​

▸ wpKsesPost(content, allowList?, options?): string

Sanitize HTML content by the wp_kses_post() requirements

Usage​

import { wpKsesPost } from '@headstartwp/core';
wpKsesPost(html);

See

https://codex.wordpress.org/Function_Reference/wp_kses_post

Parameters​

NameTypeDescription
contentstringThe content to sanitize.
allowList?IWhiteListOptional. The list of allowed HTML tags and attributes. If not set, the default allow list will be used.
options?IWpKsesPostOptionsOptional. IWpKsesPostOptions.

Returns​

string

Sanitized string of HTML.

Defined in​

packages/core/src/dom/wpKsesPost.ts:30

Data Fetching​

apiGet​

▸ apiGet(url, args?, burstCache?): Promise<{ headers: { [index: string]: any; } = receivedHeaders; json: any }>

Fetch Wrapper to handle GET requests.

Parameters​

NameTypeDefault valueDescription
urlstringundefinedThe URL where to make the request to
argsObject{}The arguments
burstCachebooleanfalseWhether it should burst cache

Returns​

Promise<{ headers: { [index: string]: any; } = receivedHeaders; json: any }>

Defined in​

packages/core/src/data/api/fetch-utils.ts:46

apiPost​

▸ apiPost(url, args?): Promise<any>

Fetch Wrapper to handle POST requests

Parameters​

NameTypeDescription
urlstringThe URL where to make the request to
argsObjectThe arguments

Returns​

Promise<any>

Defined in​

packages/core/src/data/api/fetch-utils.ts:17

Data Handling​

getPostAuthor​

▸ getPostAuthor(post): AuthorEntity[]

Returns the author object from the post object if it exists

Parameters​

NameTypeDescription
postPostEntity | PostSearchEntityThe Post object

Returns​

AuthorEntity[]

Defined in​

packages/core/src/data/utils/postHandling.ts:11

getPostTerms​

▸ getPostTerms(post): Record<string, TermEntity[]>

Returns the terms associated with the post

Parameters​

NameTypeDescription
postPostEntity | PostSearchEntityThe Post object

Returns​

Record<string, TermEntity[]>

Defined in​

packages/core/src/data/utils/postHandling.ts:22

Other​

CustomPostType​

Ƭ CustomPostType: Object

Type declaration​

NameTypeDescription
archive?string-
endpointstring-
matchSinglePath?booleanWhether this custom post type should match the archive path If set to true, then when querying a post type archive page such as /[post-type]/[post-name] the post.link property should match the current path. This will avoid matching nested posts/pages that doesn't exist for instance: /[post-type]/fake-parent-page/[post-name] will not match if this option is set to true even though post-name exists. It is strongly recommended to set this option to true, otherwise hierarchical post types (such as pages) will not work properly. Default true
single?string-
slugstring-

Defined in​

packages/core/src/types.ts:1

CustomPostTypes​

Ƭ CustomPostTypes: CustomPostType[]

Defined in​

packages/core/src/types.ts:21

CustomTaxonomies​

Ƭ CustomTaxonomies: CustomTaxonomy[]

Defined in​

packages/core/src/types.ts:43

CustomTaxonomy​

Ƭ CustomTaxonomy: Object

Type declaration​

NameTypeDescription
endpointstring-
matchArchivePath?booleanWhether this custom taxonomy should match the archive path If set to true, then when querying a taxonomy archive page such as /[taxonmy-slug]/[term-slug] the term.link property should match the current path. This will avoid matching nested categories that doesn't exist for instance: /[taxonmy-slug]/fake-parent-term/[term-slug] will not match if this option is set to true even though term-slug exists. Default false
restParam?string-
rewrite?string-
slugstring-

Defined in​

packages/core/src/types.ts:25

DOMNode​

Ƭ DOMNode: Comment | Element | Node | ProcessingInstruction | Text

Defined in​

node_modules/html-react-parser/index.d.ts:21

HTMLParser2Options​

Ƭ HTMLParser2Options: ParserOptions & DomHandlerOptions

Defined in​

node_modules/html-react-parser/index.d.ts:19

HeadlessConfig​

Ƭ HeadlessConfig: Object

Type declaration​

NameType
customPostTypes?CustomPostTypes | (defaultPostTypes: CustomPostTypes) => CustomPostTypes
customTaxonomies?CustomTaxonomies | (defaultTaxonomies: CustomTaxonomies) => CustomTaxonomies
debug?{ devMode?: boolean ; redirects?: boolean ; requests?: boolean }
debug.devMode?boolean
debug.redirects?boolean
debug.requests?boolean
host?string
hostUrl?string
integrations?Integrations
locale?string
preview?PreviewConfig
redirectStrategy?RedirectStrategy
sites?HeadlessConfig[]
sourceUrl?string
useWordPressPlugin?boolean

Defined in​

packages/core/src/types.ts:73

Integrations​

Ƭ Integrations: Object

Type declaration​

NameType
polylang?PolylangIntegration
yoastSEO?YoastSEOIntegration

Defined in​

packages/core/src/types.ts:53

Matcher​

Ƭ Matcher: Object

Type declaration​

NameType
namestring
patternstring
prioritynumber

Defined in​

packages/core/src/data/utils/matchers.ts:1

NormalizedDataForCache​

Ƭ NormalizedDataForCache<T, P>: Object

Type parameters​

Name
T
P

Type declaration​

NameType
additionalCacheObjects?NormalizedDataForCache<T, P>[]
dataFetchResponse<T>
key{ args: Partial<P> ; url: string }
key.argsPartial<P>
key.urlstring

Defined in​

packages/core/src/data/strategies/AbstractFetchStrategy.ts:97

PostOrPostsFetchStrategyResult​

Ƭ PostOrPostsFetchStrategyResult<T>: Object

Type parameters​

Name
T

Type declaration​

NameType
dataT | T[]
isArchiveboolean
isSingleboolean

Defined in​

packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:42

PreviewConfig​

Ƭ PreviewConfig: Object

Type declaration​

NameTypeDescription
alternativeAuthorizationHeader?booleanFlag to enable using the alternative authorization header. This can be useful if you have separate JWT-based authentication on your project.
usePostLinkForRedirect?booleanIf enabled, it will use the post.link property of the REST response to redirect to the appropriate route for previewing

Defined in​

packages/core/src/types.ts:58

QueriedObject​

Ƭ QueriedObject: Object

The QueriedObject represents the object that the current requests is subjected to.

Querying by taxonomy and/or author will set the queried object.

Type declaration​

NameTypeDescription
author?AuthorEntityIf the request is an author query, this will be populated with the author object
search?SearchEntityIf the request is a search query, this will be populated with the search entity object
term?TermEntityIf the request is a term query, this will be populated with the term object

Defined in​

packages/core/src/data/types/entities.ts:765

Redirect​

Ƭ Redirect: Object

Type declaration​

NameType
IDnumber
enable_regexboolean
post_statusstring
redirect_fromstring
redirect_tostring
status_codenumber

Defined in​

packages/core/src/data/types/entities.ts:705

RedirectData​

Ƭ RedirectData: Object

Type declaration​

NameTypeDescription
locationstring | undefined | nullThe redirect new location will be null if no redirect is found
statusnumberThe status number of the redirect Will be 0 if the redirect is not found

Defined in​

packages/core/src/utils/fetchRedirect.ts:5

RedirectStrategy​

Ƭ RedirectStrategy: "404" | "none" | "always"

Defined in​

packages/core/src/types.ts:23

isAnchorTagOptions​

Ƭ isAnchorTagOptions: Object

Type declaration​

NameTypeDescription
isInternalLink?booleanIf true, will check if the anchor tag contains a valid internal link. if target="_blank" then this option is not taken into account

Defined in​

packages/core/src/dom/index.ts:5

isBlockOptions​

Ƭ isBlockOptions: Object

Type declaration​

NameTypeDescription
className?string | string[]A single or array of classNames to check for If an array of class names is passed, the block will be considered valid if all of the class names are found
tagName?stringThe tagName to check for

Defined in​

packages/core/src/dom/index.ts:238

isImageTagOptions​

Ƭ isImageTagOptions: Object

Type declaration​

NameTypeDescription
hasDimensions?booleanIf true, will check if the image tag contains width and height attributes

Defined in​

packages/core/src/dom/index.ts:107

removeSourceUrlType​

Ƭ removeSourceUrlType: Object

Type declaration​

NameTypeDescription
backendUrlstringThe backend url.
linkstringThe link url, possibly with the source url.
nonEmptyLink?booleanIf the removal of source url from link leads to a empty string, this setting control whether a '/' should be returned or the empty string
publicUrl?stringThe public url. Defaults to '/'.

Defined in​

packages/core/src/utils/removeSourceUrl.ts:3

authorArchivesMatchers​

• Const authorArchivesMatchers: Matcher[]

Defined in​

packages/core/src/data/utils/matchers.ts:43

endpoints​

• Const endpoints: Object

Type declaration​

NameType
appSettingsstring
categorystring
pagesstring
postsstring
searchstring
tagsstring
tokenVerifystring
yoaststring

Defined in​

packages/core/src/utils/endpoints.ts:1

ksesAllowedList​

• Const ksesAllowedList: IWhiteList

Default Allowed HTML Attributes

See

https://codex.wordpress.org/Function_Reference/wp_kses_post

Defined in​

packages/core/src/dom/wpKsesPost.ts:266

postMatchers​

• Const postMatchers: Matcher[]

Defined in​

packages/core/src/data/utils/matchers.ts:7

postsMatchers​

• Const postsMatchers: Matcher[]

Defined in​

packages/core/src/data/utils/matchers.ts:20

searchMatchers​

• Const searchMatchers: Matcher[]

Defined in​

packages/core/src/data/utils/matchers.ts:56

youtubeEmbedRegex​

• Const youtubeEmbedRegex: RegExp

Defined in​

packages/core/src/dom/index.ts:160

HTMLReactParser​

▸ HTMLReactParser(html, options?): ReturnType<typeof domToReact>

Converts HTML string to JSX element(s).

Parameters​

NameTypeDescription
htmlstringHTML string.
options?HTMLReactParserOptionsParser options.

Returns​

ReturnType<typeof domToReact>

Defined in​

node_modules/html-react-parser/index.d.ts:51

addQueryArgs​

▸ addQueryArgs(url, args): string

Parameters​

NameType
urlstring
argsRecord<string, any>

Returns​

string

Defined in​

packages/core/src/utils/url.ts:167

asyncForEach​

▸ asyncForEach(array, callback): Promise<void>

Parameters​

NameType
arrayany[]
callback(el: any, index: number, array: any[]) => void

Returns​

Promise<void>

Defined in​

packages/core/src/utils/asyncForEach.ts:1

attributesToProps​

▸ attributesToProps(attributes, nodeName?): Props

Converts HTML/SVG DOM attributes to React props.

Parameters​

NameTypeDescription
attributesAttributesHTML/SVG DOM attributes.
nodeName?stringDOM node name.

Returns​

Props

Defined in​

node_modules/html-react-parser/lib/attributes-to-props.d.ts:17

buildQueryString​

▸ buildQueryString(data): string

Generates URL-encoded query string using input query data.

It is intended to behave equivalent as PHP's http_build_query, configured +with encoding type PHP_QUERY_RFC3986 (spaces as %20).

Example

const queryString = buildQueryString( {
   simple: 'is ok',
   arrays: [ 'are', 'fine', 'too' ],
   objects: {
      evenNested: {
         ok: 'yes',
      },
   },
} );
// "simple=is%20ok&arrays%5B0%5D=are&arrays%5B1%5D=fine&arrays%5B2%5D=too&objects%5BevenNested%5D%5Bok%5D=yes"

Parameters​

NameTypeDescription
dataRecord<string, any>Data to encode.

Returns​

string

Query string.

Defined in​

packages/core/src/utils/url.ts:129

decodeHtmlSpeciaChars​

▸ decodeHtmlSpeciaChars(text): string

Decodes HTML special chars entities

Parameters​

NameTypeDescription
textstringThe text we want to decode

Returns​

string

text with decoded html entities

Defined in​

packages/core/src/utils/decodeHtmlSpeciaChars.ts:8

domToReact​

▸ domToReact(nodes, options?): string | JSX.Element | JSX.Element[]

Converts DOM nodes to JSX element(s).

Parameters​

NameTypeDescription
nodesDOMNode[]DOM nodes.
options?HTMLReactParserOptionsParser options.

Returns​

string | JSX.Element | JSX.Element[]

Defined in​

node_modules/html-react-parser/lib/dom-to-react.d.ts:15

fetchRedirect​

▸ fetchRedirect(pathname, sourceUrl): Promise<RedirectData>

Fetches a redirect from the WordPress origin by making a HEAD request and checking the response

Parameters​

NameTypeDescription
pathnamestringThe path to the page to fetch the redirect for
sourceUrlstringThe source url

Returns​

Promise<RedirectData>

The redirect data

Defined in​

packages/core/src/utils/fetchRedirect.ts:51

getAuthHeader​

▸ getAuthHeader(): null

Returns​

null

Defined in​

packages/core/src/data/api/fetch-utils.ts:3

getCustomPostType​

▸ getCustomPostType(slug, sourceUrl?): undefined | CustomPostType

Returns a single post type by slug if defined

Parameters​

NameTypeDescription
slugstringpost type slug
sourceUrl?string

Returns​

undefined | CustomPostType

Defined in​

packages/core/src/utils/config.ts:251

getCustomPostTypes​

▸ getCustomPostTypes(sourceUrl?): CustomPostTypes

Returns the available post types

Parameters​

NameType
sourceUrl?string

Returns​

CustomPostTypes

Defined in​

packages/core/src/utils/config.ts:228

getCustomPostTypesSlugs​

▸ getCustomPostTypesSlugs(sourceUrl?): string[]

Returns the available post type slugs

Parameters​

NameType
sourceUrl?string

Returns​

string[]

Defined in​

packages/core/src/utils/config.ts:239

getCustomTaxonomies​

▸ getCustomTaxonomies(sourceUrl?): CustomTaxonomies

Returns the available taxonomies

Parameters​

NameType
sourceUrl?string

Returns​

CustomTaxonomies

Defined in​

packages/core/src/utils/config.ts:188

getCustomTaxonomy​

▸ getCustomTaxonomy(slug, sourceUrl?): undefined | CustomTaxonomy

Returns a single post type by slug if defined

Parameters​

NameTypeDescription
slugstringpost type slug
sourceUrl?string

Returns​

undefined | CustomTaxonomy

Defined in​

packages/core/src/utils/config.ts:217

getCustomTaxonomySlugs​

▸ getCustomTaxonomySlugs(sourceUrl?): string[]

Returns the available taxonomy slugs

Parameters​

NameType
sourceUrl?string

Returns​

string[]

Defined in​

packages/core/src/utils/config.ts:200

getHeadlessConfig​

▸ getHeadlessConfig(): Object

Returns the contents of headless.config.js

This function requires framework integration in order to work. The contents of headless.config.js +needs to be injected at build time into a global variable.

Make sure you are using one of the framework's integration (such as next) before using this function.

Returns​

Object

The contents of headless.config.js

NameType
customPostTypesCustomPostTypes
customTaxonomiesCustomTaxonomies
debugundefined | { devMode?: boolean ; redirects?: boolean ; requests?: boolean }
hostUrlstring
integrationsundefined | Integrations
previewundefined | PreviewConfig
redirectStrategyRedirectStrategy
sitesHeadlessConfig[]
sourceUrlundefined | string
useWordPressPluginboolean

Defined in​

packages/core/src/utils/config.ts:22

getHeadstartWPConfig​

▸ getHeadstartWPConfig(): Object

Returns the contents of headless.config.js

This function requires framework integration in order to work. The contents of headless.config.js +needs to be injected at build time into a global variable.

Make sure you are using one of the framework's integration (such as next) before using this function.

Returns​

Object

The contents of headless.config.js

NameType
customPostTypesCustomPostTypes
customTaxonomiesCustomTaxonomies
debugundefined | { devMode?: boolean ; redirects?: boolean ; requests?: boolean }
hostUrlstring
integrationsundefined | Integrations
previewundefined | PreviewConfig
redirectStrategyRedirectStrategy
sitesHeadlessConfig[]
sourceUrlundefined | string
useWordPressPluginboolean

Defined in​

packages/core/src/utils/config.ts:22

getHostUrl​

▸ getHostUrl(): string

Returns the WP URL based on the headless config

Returns​

string

Defined in​

packages/core/src/utils/config.ts:268

getQueryArgs​

▸ getQueryArgs(url): Record<string, any>

Returns an object of query arguments of the given URL. If the given URL is +invalid or has no querystring, an empty object is returned.

Example

const foo = getQueryArgs( 'https://wordpress.org?foo=bar&bar=baz' );
// { "foo": "bar", "bar": "baz" }

Parameters​

NameTypeDescription
urlstringURL.

Returns​

Record<string, any>

Query args object.

Defined in​

packages/core/src/utils/url.ts:78

getQueryString​

▸ getQueryString(url): any

Parameters​

NameType
urlstring

Returns​

any

Defined in​

packages/core/src/utils/url.ts:49

getSite​

▸ getSite(site?): HeadlessConfig

Get a config for a specific site

Parameters​

NameType
site?HeadlessConfig

Returns​

HeadlessConfig

Defined in​

packages/core/src/utils/config.ts:113

getSiteByHost​

▸ getSiteByHost(hostOrUrl, locale?): null | HeadlessConfig

Finds a site by host and optionally locale

Parameters​

NameTypeDescription
hostOrUrlstringThe hostname
locale?string

Returns​

null | HeadlessConfig

Defined in​

packages/core/src/utils/config.ts:138

getSiteBySourceUrl​

▸ getSiteBySourceUrl(sourceUrl): HeadlessConfig

Get a site by source url

Parameters​

NameType
sourceUrlstring

Returns​

HeadlessConfig

HeadlessConfig

Defined in​

packages/core/src/utils/config.ts:176

getWPUrl​

▸ getWPUrl(): string

Returns the WP URL based on the headless config

Returns​

string

Defined in​

packages/core/src/utils/config.ts:260

htmlToDOM​

▸ htmlToDOM(html, options?): (Comment | Element | ProcessingInstruction | Text)[]

Parses HTML string to DOM nodes in Node.js.

This is the same method as require('htmlparser2').parseDOM +https://github.com/fb55/htmlparser2/blob/v6.0.0/src/index.ts#L29-L41

Parameters​

NameTypeDescription
htmlstringHTML markup.
options?DomHandlerOptionsParser options (https://github.com/fb55/domhandler/tree/v5.0.3#readme).

Returns​

(Comment | Element | ProcessingInstruction | Text)[]

Defined in​

node_modules/html-dom-parser/lib/server/html-to-dom.d.ts:21

isElement​

▸ isElement(node): node is Element

Checks if the node is an Element.

We rely on this function to avoid issues with instanceof.

See

https://github.com/10up/headstartwp/issues/504

Parameters​

NameTypeDescription
nodeDOMNodeThe dom node

Returns​

node is Element

Whether the node is of type element or not

Defined in​

packages/core/src/dom/index.ts:25

isExternalUrl​

▸ isExternalUrl(link): boolean

Checks if the provided link is an external Url.

Inspired on the Frontity implementation

See

https://github.com/frontity/frontity/blob/dev/packages/components/link/utils.ts

Parameters​

NameTypeDescription
linkstringThe link Url.

Returns​

boolean

True if the link is an external Url.

Defined in​

packages/core/src/utils/isExternalUrl.ts:12

▸ isInternalLink(url, site?): boolean

Checks if the url is for an internal link

Parameters​

NameTypeDescription
urlstringThe url to check
site?HeadlessConfig(optional) the site config

Returns​

boolean

Defined in​

packages/core/src/utils/isInternalLink.ts:14

log​

▸ log(type, ...args): void

Parameters​

NameType
typeLOGTYPE
...argsany[]

Returns​

void

Defined in​

packages/core/src/utils/log.ts:9

removeFieldsFromPostRelatedData​

▸ removeFieldsFromPostRelatedData(fieldsToRemove, post): PostEntity | { _embedded: { author: AuthorEntity[] ; wp:featuredmedia: any ; wp:term: TermEntity[][] } ; author?: AuthorEntity[] ; categories?: number[] ; comment_status?: "open" | "closed" ; content: Rendered ; date: string ; date_gmt: string ; excerpt: Rendered ; featured_media: number ; format: "link" | "status" | "standard" | "aside" | "chat" | "gallery" | "image" | "quote" | "video" | "audio" ; guid: Rendered ; id: number ; link: string ; meta: Record<string, unknown> ; modified: string ; modified_gmt: string ; ping_status: "open" | "closed" ; slug: string ; status: "publish" | "future" | "draft" | "pending" | "private" ; sticky: boolean ; tags?: number[] ; template: string ; terms?: Record<string, TermEntity[]> ; title: Rendered ; type: string ; yoast_head?: null | string ; yoast_head_json?: null | Record<string, any> }

Parameters​

NameType
fieldsToRemove(string | number)[]
postPostEntity

Returns​

PostEntity | { _embedded: { author: AuthorEntity[] ; wp:featuredmedia: any ; wp:term: TermEntity[][] } ; author?: AuthorEntity[] ; categories?: number[] ; comment_status?: "open" | "closed" ; content: Rendered ; date: string ; date_gmt: string ; excerpt: Rendered ; featured_media: number ; format: "link" | "status" | "standard" | "aside" | "chat" | "gallery" | "image" | "quote" | "video" | "audio" ; guid: Rendered ; id: number ; link: string ; meta: Record<string, unknown> ; modified: string ; modified_gmt: string ; ping_status: "open" | "closed" ; slug: string ; status: "publish" | "future" | "draft" | "pending" | "private" ; sticky: boolean ; tags?: number[] ; template: string ; terms?: Record<string, TermEntity[]> ; title: Rendered ; type: string ; yoast_head?: null | string ; yoast_head_json?: null | Record<string, any> }

Defined in​

packages/core/src/data/utils/postHandling.ts:51

removeSourceUrl​

▸ removeSourceUrl(«destructured»): string

Make the link relative if it belongs to the backend, to force client-side +navigation.

Inspired on the Frontity implementation

See

https://github.com/frontity/frontity/blob/dev/packages/components/link/utils.ts

Parameters​

NameType
«destructured»removeSourceUrlType

Returns​

string

The URL without the Source URL.

Defined in​

packages/core/src/utils/removeSourceUrl.ts:42

setHeadlessConfig​

▸ setHeadlessConfig(config): void

Parameters​

NameType
configHeadlessConfig

Returns​

void

Defined in​

packages/core/src/utils/config.ts:6

setHeadstartWPConfig​

▸ setHeadstartWPConfig(config): void

Parameters​

NameType
configHeadlessConfig

Returns​

void

Defined in​

packages/core/src/utils/config.ts:6

stripTags​

▸ stripTags(html): any

Utility functions to strip any tags

Parameters​

NameTypeDescription
htmlanyThe html string

Returns​

any

Defined in​

packages/core/src/dom/stripTags.ts:8

warn​

▸ warn(message): void

Logs a warning in the console in dev mode

Example

warn("You should do/change something.")

Parameters​

NameTypeDescription
messagestringThe message that describes the warning.

Returns​

void

Defined in​

packages/core/src/utils/errors.ts:45

Utility Functions​

parsePath​

▸ parsePath(matchers, path): Record<string, string>

Parses a path and extracts the parameters from it

Parameters​

NameTypeDescription
matchersMatcher[]An array of Matchers
pathstringThe path

Returns​

Record<string, string>

the extracted parameters

Defined in​

packages/core/src/data/utils/parsePath.ts:46

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/modules/headstartwp_next/index.html b/api/modules/headstartwp_next/index.html index 51f5106ea..3c92b7bcd 100644 --- a/api/modules/headstartwp_next/index.html +++ b/api/modules/headstartwp_next/index.html @@ -7,31 +7,31 @@ - - + +
-
Skip to main content

Module: @headstartwp/next

Namespaces​

Interfaces​

API handlers​

previewHandler​

▸ previewHandler(req, res, options?): Promise<void>

The PreviewHandler is responsible for handling preview requests.

Handling Previews requires the Headless WordPress Plugin.

Important: This function is meant to be used in a api route at /pages/api/preview.

Usage​

// pages/api/preview.js
import { previewHandler } from '@headstartwp/next';

export default async function handler(req, res) {
    return previewHandler(req, res);
}

Parameters​

NameTypeDescription
reqNextApiRequestThe request object,
resNextApiResponse<any>The response object.
optionsPreviewHandlerOptionsThe PreviewHandlerOptions PreviewHandlerOptions

Returns​

Promise<void>

A response object.

Defined in​

packages/next/src/handlers/previewHandler.ts:120

revalidateHandler​

▸ revalidateHandler(req, res): Promise<void>

The RevalidateHandler is responsible for handling revalidate requests.

Handling revalidate requires the Headless WordPress Plugin.

Important: This function is meant to be used in a api route e.g: /pages/api/revalidate.

Usage​

// pages/api/revalidate.js
import { revalidateHandler } from '@headstartwp/next';

export default async function handler(req, res) {
    return revalidateHandler(req, res);
}

Parameters​

NameTypeDescription
reqNextApiRequestThe request object,
resNextApiResponse<any>The response object.

Returns​

Promise<void>

A response object.

Defined in​

packages/next/src/handlers/revalidateHandler.ts:30

Data Fetching Hooks​

useAppSettings​

▸ useAppSettings<T, P>(params?, options?): useAppSettingsResponse<T>

The useAppSettings hook

Usage​

const { data, loading, error } = useAppSettings();

// check loading and error states
Server-Side-Rendering or Static-Site-Generation​
export async function getServerSideProps(context) {
    const useAppSettingsData = await fetchHookData(useAppSettings.fetcher(), context);
    return addHookData([useAppSettingsData], {});
}

Important: You most likely want to fetch app settings on every route so -that you can access global settings and menus in your pages & components

Type parameters​

NameType
Textends AppEntity = AppEntity
Pextends EndpointParams = EndpointParams

Parameters​

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<T>>Options for the SWR configuration

Returns​

useAppSettingsResponse<T>

Defined in​

packages/next/src/data/hooks/useAppSettings.ts:33

useAuthorArchive​

▸ useAuthorArchive<T, P>(params?, options?): usePostsResponse<T>

The useAuthorArchive hook. Returns a collection of post entities queried by author

This hook must be used with a catch-all route [...path].js (e.g: pages/author/[...path].js)

Important: Use a catch-all and not an optional catch-all route ([[...path]].js) as the author param in the url is required.

In order to automatically map URL params create a catch-all route named [...path].js. -You can create the catch-all at any level e.g: pages/author/[...path].js, etc.

The pages/author/[...path].js route for instance would yield a URL like this: /author-name/page/2, /author-name/category/category-name/page/3, etc.

The following URL params are supported:

  • Category (/author-name/category/category-name)
  • Tag (/author-name/tag/tag-name)
  • Author (/author/author-name)
  • Pagination (/page/2)
  • Custom Taxonomy (/author//taxonomy/term-name)

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters​

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<T[]>>Options for the SWR configuration

Returns​

usePostsResponse<T>

Defined in​

packages/next/src/data/hooks/useAuthorArchive.ts:29

useMenu​

▸ useMenu(menuLocation, options?): useMenuResponse

The useMenu hooks. Returns a Menu object.

Important: This hook depends on useAppSettings. If you want to enable SSR;SSG for +

Module: @headstartwp/next

Namespaces​

Interfaces​

API handlers​

previewHandler​

▸ previewHandler(req, res, options?): Promise<void>

The PreviewHandler is responsible for handling preview requests.

Handling Previews requires the Headless WordPress Plugin.

Important: This function is meant to be used in a api route at /pages/api/preview.

Usage​

// pages/api/preview.js
import { previewHandler } from '@headstartwp/next';

export default async function handler(req, res) {
    return previewHandler(req, res);
}

Parameters​

NameTypeDescription
reqNextApiRequestThe request object,
resNextApiResponse<any>The response object.
optionsPreviewHandlerOptionsThe PreviewHandlerOptions PreviewHandlerOptions

Returns​

Promise<void>

A response object.

Defined in​

packages/next/src/handlers/previewHandler.ts:120

revalidateHandler​

▸ revalidateHandler(req, res): Promise<void>

The RevalidateHandler is responsible for handling revalidate requests.

Handling revalidate requires the Headless WordPress Plugin.

Important: This function is meant to be used in a api route e.g: /pages/api/revalidate.

Usage​

// pages/api/revalidate.js
import { revalidateHandler } from '@headstartwp/next';

export default async function handler(req, res) {
    return revalidateHandler(req, res);
}

Parameters​

NameTypeDescription
reqNextApiRequestThe request object,
resNextApiResponse<any>The response object.

Returns​

Promise<void>

A response object.

Defined in​

packages/next/src/handlers/revalidateHandler.ts:30

Data Fetching Hooks​

useAppSettings​

▸ useAppSettings<T, P>(params?, options?): useAppSettingsResponse<T>

The useAppSettings hook

Usage​

const { data, loading, error } = useAppSettings();

// check loading and error states
Server-Side-Rendering or Static-Site-Generation​
export async function getServerSideProps(context) {
    const useAppSettingsData = await fetchHookData(useAppSettings.fetcher(), context);
    return addHookData([useAppSettingsData], {});
}

Important: You most likely want to fetch app settings on every route so +that you can access global settings and menus in your pages & components

Type parameters​

NameType
Textends AppEntity = AppEntity
Pextends EndpointParams = EndpointParams

Parameters​

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<T>>Options for the SWR configuration

Returns​

useAppSettingsResponse<T>

Defined in​

packages/next/src/data/hooks/useAppSettings.ts:33

useAuthorArchive​

▸ useAuthorArchive<T, P>(params?, options?): usePostsResponse<T>

The useAuthorArchive hook. Returns a collection of post entities queried by author

This hook must be used with a catch-all route [...path].js (e.g: pages/author/[...path].js)

Important: Use a catch-all and not an optional catch-all route ([[...path]].js) as the author param in the url is required.

In order to automatically map URL params create a catch-all route named [...path].js. +You can create the catch-all at any level e.g: pages/author/[...path].js, etc.

The pages/author/[...path].js route for instance would yield a URL like this: /author-name/page/2, /author-name/category/category-name/page/3, etc.

The following URL params are supported:

  • Category (/author-name/category/category-name)
  • Tag (/author-name/tag/tag-name)
  • Author (/author/author-name)
  • Pagination (/page/2)
  • Custom Taxonomy (/author//taxonomy/term-name)

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters​

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<T[]>>Options for the SWR configuration

Returns​

usePostsResponse<T>

Defined in​

packages/next/src/data/hooks/useAuthorArchive.ts:29

useMenu​

▸ useMenu(menuLocation, options?): useMenuResponse

The useMenu hooks. Returns a Menu object.

Important: This hook depends on useAppSettings. If you want to enable SSR;SSG for this hook you will need to fetch app settings on the server side.

Usage​

Basic usage​

export const Nav = () => {
    const { data, loading, error } = useMenu('primary-menu');

    // handle loading, error states

    return <Menu items={data} css={navStyles} />;
}
Re-fetching client-side on focus and/or mount​

If you are fetching app settings on the server, you can enable re-fetching on focus and/or mount -to ensure menus are always up-to date even when using SSG/ISR.

export const Nav = () => {
    const { data, loading, error } = useMenu('primary-menu', {
        revalidateOnFocus: true,
        revalidateOnMount: true,
    });

    // handle loading, error states

    return <Menu items={data} css={navStyles} />;
}

Parameters​

NameTypeDescription
menuLocationstringThe slug of the menu location you want to fetch
optionsFetchHookOptions<FetchResponse<AppEntity>>SWR configuration options

Returns​

useMenuResponse

Defined in​

packages/next/src/data/hooks/useMenu.ts:46

usePost​

▸ usePost<T, P>(params?, options?): usePostResponse<T>

The usePost hook. Returns a single post entity

In order to automatically map URL params create a catch-all route named [...path].js. -You can create the catch-all at any level e.g: pages/[...path].js, pages/blog/[...path].js, etc.

The pages/[...path].js route for instance would yield a URL like this: /post-slug, /2020/01/01/post-slug, etc.

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostParams = PostParams

Parameters​

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<T>>Options for the SWR configuration

Returns​

usePostResponse<T>

Defined in​

packages/next/src/data/hooks/usePost.ts:18

usePostOrPosts​

▸ usePostOrPosts<T, P>(params?, options?): usePostOrPostResponse<T>

The usePostOrPosts hook

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostOrPostsParams = PostOrPostsParams

Parameters​

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<PostOrPostsFetchStrategyResult<T>>>Options for the SWR configuration

Returns​

usePostOrPostResponse<T>

Defined in​

packages/next/src/data/hooks/usePostOrPosts.ts:18

usePosts​

▸ usePosts<T, P>(params?, options?): usePostsResponse<T>

The usePost hook. Returns a collection of post entities

In order to automatically map URL params create a catch-all route named [[...path]].js. +to ensure menus are always up-to date even when using SSG/ISR.

export const Nav = () => {
    const { data, loading, error } = useMenu('primary-menu', {
        revalidateOnFocus: true,
        revalidateOnMount: true,
    });

    // handle loading, error states

    return <Menu items={data} css={navStyles} />;
}

Parameters​

NameTypeDescription
menuLocationstringThe slug of the menu location you want to fetch
optionsFetchHookOptions<FetchResponse<AppEntity>>SWR configuration options

Returns​

useMenuResponse

Defined in​

packages/next/src/data/hooks/useMenu.ts:46

usePost​

▸ usePost<T, P>(params?, options?): usePostResponse<T>

The usePost hook. Returns a single post entity

In order to automatically map URL params create a catch-all route named [...path].js. +You can create the catch-all at any level e.g: pages/[...path].js, pages/blog/[...path].js, etc.

The pages/[...path].js route for instance would yield a URL like this: /post-slug, /2020/01/01/post-slug, etc.

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostParams = PostParams

Parameters​

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<T>>Options for the SWR configuration

Returns​

usePostResponse<T>

Defined in​

packages/next/src/data/hooks/usePost.ts:18

usePostOrPosts​

▸ usePostOrPosts<T, P>(params?, options?): usePostOrPostResponse<T>

The usePostOrPosts hook

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostOrPostsParams = PostOrPostsParams

Parameters​

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<PostOrPostsFetchStrategyResult<T>>>Options for the SWR configuration

Returns​

usePostOrPostResponse<T>

Defined in​

packages/next/src/data/hooks/usePostOrPosts.ts:18

usePosts​

▸ usePosts<T, P>(params?, options?): usePostsResponse<T>

The usePost hook. Returns a collection of post entities

In order to automatically map URL params create a catch-all route named [[...path]].js. You can create the catch-all at any level e.g: pages/[[...path]].js, pages/blog/[[...path]].js, etc.

The pages/blog/[[...path]].js route for instance would yield a URL like this: /blog, /blog/page/2, /blog/category/category-name/page/3, etc.

The following URL params are supported:

  • Category (/category/category-name)
  • Tag (/tag/tag-name)
  • Author (/author/author-name)
  • Pagination (/page/2)
  • Date (/YYYY/MM/DD)
  • Custom Taxonomy (/taxonomy/term-name)

Handling multiple WordPress routes in a single next.js route​

The usePosts hook is very flexible and can handle multiple WordPress routes in a single next.js route when using the optional-catch-all route ([[...path]].js). -Alongside with the actual data, usePosts also returns information about the current route so you can conditionally load different components.

const params = { postType: 'post' };
const Posts = () => {
     const { data, pageType } = usePosts(params);

     if (pageType.isAuthorArchive) {
       return <AuthorArchive data={data} />
     }

     if (pageType.isCategoryArchive) {
       return <CategoryArchive data={data} />
     }

     if (pageType.isTaxonomyArchive && pageType.taxonomy === 'my-custom-taxonomy' ) {
       return <TaxonomyArchive data={data} />
     }

     return (
       <div>
         <ul>
           {data.posts.map((post) => (
              <li key={post.id}>
                {post.title.rendered}
              </li>
           ))}
      </ul>
       </div>
     );
};

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters​

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<T[]>>Options for the SWR configuration

Returns​

usePostsResponse<T>

Defined in​

packages/next/src/data/hooks/usePosts.ts:62

useSearch​

▸ useSearch<T, P>(params?, options?): useSearchResponse<T>

The useSearch hook. Returns a collection of search entities

In order to automatically map URL params create a catch-all route named [...path].js. -You can create the catch-all at any level e.g: pages/search/[[...path]].js

The pages/search/[[...path]].js route for instance would yield a URL like this: /search/[term]/page/[number], /search/[term] etc

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters​

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<T[]>>Options for the SWR configuration

Returns​

useSearchResponse<T>

Defined in​

packages/next/src/data/hooks/useSearch.ts:18

useSearchNative​

▸ useSearchNative<T, P>(params?, options?): useSearchNativeResponse<T>

The useSearchNative hook. Returns a collection of search entities retrieved through the WP native search endpoint.

In order to automatically map URL params create a catch-all route named [...path].js. -You can create the catch-all at any level e.g: pages/search/[[...path]].js

The pages/search/[[...path]].js route for instance would yield a URL like this: /search/[term]/page/[number], /search/[term] etc

Type parameters​

NameType
Textends PostSearchEntity | TermSearchEntity = PostSearchEntity | TermSearchEntity
Pextends SearchParams = SearchParams

Parameters​

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<T[]>>Options for the SWR configuration

Returns​

useSearchNativeResponse<T>

Defined in​

packages/next/src/data/hooks/useSearchNative.ts:18

useSeo​

▸ useSeo(format): Record<string, any> | null

The useSeo hook. Returns the current SEO object

Usage​

const seo = useSeo();

Parameters​

NameTypeDescription
format"json"how to return the seo object. Defaults to 'json'

Returns​

Record<string, any> | null

Defined in​

packages/next/src/data/hooks/useSeo.ts:18

▸ useSeo(format): string | null

Parameters​

NameType
format"html"

Returns​

string | null

Defined in​

packages/next/src/data/hooks/useSeo.ts:19

▸ useSeo(): Record<string, any> | null

Returns​

Record<string, any> | null

Defined in​

packages/next/src/data/hooks/useSeo.ts:20

useTerms​

▸ useTerms<T, P>(params?, options?): useTermsResponse<T>

The useTerms hook. Returns a collection of term entities

Usage​

const { loading, data } = useTerms({ taxonomy: 'category', slug: 'cat-name' });

Type parameters​

NameType
Textends TermEntity = TermEntity
Pextends TaxonomyArchiveParams = TaxonomyArchiveParams

Parameters​

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<T[]>>Options for the SWR configuration

Returns​

useTermsResponse<T>

Defined in​

packages/next/src/data/hooks/useTerms.ts:19

Next.js Data Fetching Utilities​

addHookData​

▸ addHookData<P>(_hookStates, nextProps): Object

The addHookData function is responsible for collecting all of the results from the fetchHookData function calls -and prepares the shape of the data to match what the frameworks expects (such as setting initial values for SWR and collecting SEO data).

Usage​

export async function getServerSideProps(context) {
    try {
        const usePostsHook = await fetchHookData(usePosts.fetcher(),context);
        const useAppSettingsHook = await fetchHookData(useAppSettings.fetcher(),context);
        return addHookData([usePostsHook, useAppSettingsHook], {});
    } catch (e) {
        return handleError(e, context);
    }
}

Type parameters​

NameType
P{ [key: string]: any; }

Parameters​

NameTypeDescription
_hookStatesHookState<FetchResponse<Entity | Entity[]>>[]
nextPropsNextJSProps<P>Any additional props to pass to Next.js page routes.

Returns​

Object

NameType
notFound?boolean
props{ fallback: {} ; seo: { yoast_head: string = seo; yoast_head_json: {} = seo_json } ; themeJSON: {} }
props.fallback{}
props.seo{ yoast_head: string = seo; yoast_head_json: {} = seo_json }
props.seo.yoast_headstring
props.seo.yoast_head_json{}
props.themeJSON{}
redirect?Redirect
revalidate?number | boolean

Defined in​

packages/next/src/data/server/addHookData.ts:59

convertToPath​

▸ convertToPath(args): string

Creates a path from array of arguments

Parameters​

NameTypeDescription
argsundefined | string[]Array of catch-all arguments

Returns​

string

Defined in​

packages/next/src/data/convertToPath.ts:8

fetchHookData​

▸ fetchHookData<T, P, R>(fetchStrategy, ctx, options?): Promise<{ additionalCacheObjects: any ; data: FetchResponse<R> ; isMainQuery: boolean ; key: string }>

A function that implements data fetching on the server. This should be used in getServerSideProps +Alongside with the actual data, usePosts also returns information about the current route so you can conditionally load different components.

const params = { postType: 'post' };
const Posts = () => {
     const { data, pageType } = usePosts(params);

     if (pageType.isAuthorArchive) {
       return <AuthorArchive data={data} />
     }

     if (pageType.isCategoryArchive) {
       return <CategoryArchive data={data} />
     }

     if (pageType.isTaxonomyArchive && pageType.taxonomy === 'my-custom-taxonomy' ) {
       return <TaxonomyArchive data={data} />
     }

     return (
       <div>
         <ul>
           {data.posts.map((post) => (
              <li key={post.id}>
                {post.title.rendered}
              </li>
           ))}
      </ul>
       </div>
     );
};

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters​

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<T[]>>Options for the SWR configuration

Returns​

usePostsResponse<T>

Defined in​

packages/next/src/data/hooks/usePosts.ts:62

useSearch​

▸ useSearch<T, P>(params?, options?): useSearchResponse<T>

The useSearch hook. Returns a collection of search entities

In order to automatically map URL params create a catch-all route named [...path].js. +You can create the catch-all at any level e.g: pages/search/[[...path]].js

The pages/search/[[...path]].js route for instance would yield a URL like this: /search/[term]/page/[number], /search/[term] etc

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters​

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<T[]>>Options for the SWR configuration

Returns​

useSearchResponse<T>

Defined in​

packages/next/src/data/hooks/useSearch.ts:18

useSearchNative​

▸ useSearchNative<T, P>(params?, options?): useSearchNativeResponse<T>

The useSearchNative hook. Returns a collection of search entities retrieved through the WP native search endpoint.

In order to automatically map URL params create a catch-all route named [...path].js. +You can create the catch-all at any level e.g: pages/search/[[...path]].js

The pages/search/[[...path]].js route for instance would yield a URL like this: /search/[term]/page/[number], /search/[term] etc

Type parameters​

NameType
Textends PostSearchEntity | TermSearchEntity = PostSearchEntity | TermSearchEntity
Pextends SearchParams = SearchParams

Parameters​

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<T[]>>Options for the SWR configuration

Returns​

useSearchNativeResponse<T>

Defined in​

packages/next/src/data/hooks/useSearchNative.ts:18

useSeo​

▸ useSeo(format): Record<string, any> | null

The useSeo hook. Returns the current SEO object

Usage​

const seo = useSeo();

Parameters​

NameTypeDescription
format"json"how to return the seo object. Defaults to 'json'

Returns​

Record<string, any> | null

Defined in​

packages/next/src/data/hooks/useSeo.ts:18

▸ useSeo(format): string | null

Parameters​

NameType
format"html"

Returns​

string | null

Defined in​

packages/next/src/data/hooks/useSeo.ts:19

▸ useSeo(): Record<string, any> | null

Returns​

Record<string, any> | null

Defined in​

packages/next/src/data/hooks/useSeo.ts:20

useTerms​

▸ useTerms<T, P>(params?, options?): useTermsResponse<T>

The useTerms hook. Returns a collection of term entities

Usage​

const { loading, data } = useTerms({ taxonomy: 'category', slug: 'cat-name' });

Type parameters​

NameType
Textends TermEntity = TermEntity
Pextends TaxonomyArchiveParams = TaxonomyArchiveParams

Parameters​

NameTypeDescription
paramsPartial<P>The parameters accepted by the hook
optionsFetchHookOptions<FetchResponse<T[]>>Options for the SWR configuration

Returns​

useTermsResponse<T>

Defined in​

packages/next/src/data/hooks/useTerms.ts:19

Next.js Data Fetching Utilities​

addHookData​

▸ addHookData<P>(_hookStates, nextProps): Object

The addHookData function is responsible for collecting all of the results from the fetchHookData function calls +and prepares the shape of the data to match what the frameworks expects (such as setting initial values for SWR and collecting SEO data).

Usage​

export async function getServerSideProps(context) {
    try {
        const usePostsHook = await fetchHookData(usePosts.fetcher(),context);
        const useAppSettingsHook = await fetchHookData(useAppSettings.fetcher(),context);
        return addHookData([usePostsHook, useAppSettingsHook], {});
    } catch (e) {
        return handleError(e, context);
    }
}

Type parameters​

NameType
P{ [key: string]: any; }

Parameters​

NameTypeDescription
_hookStatesHookState<FetchResponse<Entity | Entity[]>>[]
nextPropsNextJSProps<P>Any additional props to pass to Next.js page routes.

Returns​

Object

NameType
notFound?boolean
props{ fallback: {} ; seo: { yoast_head: string = seo; yoast_head_json: {} = seo_json } ; themeJSON: {} }
props.fallback{}
props.seo{ yoast_head: string = seo; yoast_head_json: {} = seo_json }
props.seo.yoast_headstring
props.seo.yoast_head_json{}
props.themeJSON{}
redirect?Redirect
revalidate?number | boolean

Defined in​

packages/next/src/data/server/addHookData.ts:59

convertToPath​

▸ convertToPath(args): string

Creates a path from array of arguments

Parameters​

NameTypeDescription
argsundefined | string[]Array of catch-all arguments

Returns​

string

Defined in​

packages/next/src/data/convertToPath.ts:8

fetchHookData​

▸ fetchHookData<T, P, R>(fetchStrategy, ctx, options?): Promise<{ additionalCacheObjects: any ; data: FetchResponse<R> ; isMainQuery: boolean ; key: string }>

A function that implements data fetching on the server. This should be used in getServerSideProps or getStaticProps.

Data fetching will be performed by the specified strategy and URL params will be automatically extracted -from `context

Usage​

export async function getServerSideProps(context) {
    try {
        const usePostsHook = await fetchHookData(usePosts.fetcher(),context);

        return addHookData([usePostsHook], {});
    } catch (e) {
        return handleError(e, context);
    }
}

@param fetchStrategy The fetch strategy to use. Typically this is exposed by the hook e.g: usePosts.fetcher() +from `context

Usage​

export async function getServerSideProps(context) {
    try {
        const usePostsHook = await fetchHookData(usePosts.fetcher(),context);

        return addHookData([usePostsHook], {});
    } catch (e) {
        return handleError(e, context);
    }
}´

@param fetchStrategy The fetch strategy to use. Typically this is exposed by the hook e.g: usePosts.fetcher() @param ctx The Next.js context, either the one from getServerSideProps or getStaticProps -@param options See {@link FetchHookDataOptions}

@returns An object with a key of data and a value of the fetched data.

Type parameters​

NameType
Tunknown
Pextends EndpointParams = EndpointParams
RT

Parameters​

NameType
fetchStrategyAbstractFetchStrategy<T, P, R>
ctxGetServerSidePropsContext<any, PreviewData> | GetStaticPropsContext<any, PreviewData>
optionsFetchHookDataOptions<P, T>

Returns​

Promise<{ additionalCacheObjects: any ; data: FetchResponse<R> ; isMainQuery: boolean ; key: string }>

Defined in​

packages/next/src/data/server/fetchHookData.ts:81

handleError​

▸ handleError(error, ctx, rootRoute?): Promise<GetServerSidePropsResult<{}>>

The handleError function is responsible for handling errors that occur during +@param options See {@link FetchHookDataOptions}

@returns An object with a key of data and a value of the fetched data.

Type parameters​

NameType
Tunknown
Pextends EndpointParams = EndpointParams
RT

Parameters​

NameType
fetchStrategyAbstractFetchStrategy<T, P, R>
ctxGetServerSidePropsContext<any, PreviewData> | GetStaticPropsContext<any, PreviewData>
optionsFetchHookDataOptions<P, T>

Returns​

Promise<{ additionalCacheObjects: any ; data: FetchResponse<R> ; isMainQuery: boolean ; key: string }>

Defined in​

packages/next/src/data/server/fetchHookData.ts:124

handleError​

▸ handleError(error, ctx, rootRoute?): Promise<GetServerSidePropsResult<{}>>

The handleError function is responsible for handling errors that occur during data fetching in getServerSideProps or getStaticProps.

It also handles redirects if redirectStrategy is set to 404 in headless.config.js

If error is of type NotFoundError it will redirect to the 404 page. Otherwise it will -return a server error (500) page

Usage​

export async function getServerSideProps(context) {
    try {
        const usePostsHook = await fetchHookData(usePosts.fetcher(),context);
        return addHookData([usePostsHook], {});
    } catch (e) {
        return handleError(e, context);
    }
}

Parameters​

NameTypeDefault valueDescription
errorErrorundefinedThe error object
ctxHeadlessGetServerSidePropsContext<ParsedUrlQuery> | HeadlessGetStaticPropsPropsContext<ParsedUrlQuery>undefinedThe Next.js context
rootRoutestring''The root route (deprecated/unnecessary). This needs to be revisited

Returns​

Promise<GetServerSidePropsResult<{}>>

Defined in​

packages/next/src/data/server/handleError.ts:62

Other​

HeadlessAppProps​

Ƭ HeadlessAppProps: Object

The props supported by HeadlessApp.

Type declaration​

NameTypeDescription
children?ReactNode-
handleYoast?booleanIf true, will automatically load yoast seo metadata into the head Default true
pagePropsanyThe 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
settingsSettingsContextPropsSupported settings by the framework. Such as custom image component, custom link component etc. See SettingsContextProps
swrConfigDataFetchingProviderProps["swrConfig"]Pass any configuration to the SWR library. Globally. These settings can be overridden at the hook level.
useYoastHtml?booleanIf 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.

Defined in​

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

HeadlessGetServerSideProps​

Ƭ HeadlessGetServerSideProps<P, Q>: GetServerSideProps<P, Q, PreviewData>

Type parameters​

NameType
Pextends Object = { [key: string]: any; }
Qextends ParsedUrlQuery = ParsedUrlQuery

Defined in​

packages/next/src/data/types.ts:16

HeadlessGetServerSidePropsContext​

Ƭ HeadlessGetServerSidePropsContext<Q>: GetServerSidePropsContext<Q, PreviewData>

Type parameters​

NameType
Qextends ParsedUrlQuery = ParsedUrlQuery

Defined in​

packages/next/src/data/types.ts:10

HeadlessGetStaticProps​

Ƭ HeadlessGetStaticProps<P, Q>: GetStaticProps<P, Q, PreviewData>

Type parameters​

NameType
Pextends Object = { [key: string]: any; }
Qextends ParsedUrlQuery = ParsedUrlQuery

Defined in​

packages/next/src/data/types.ts:21

HeadlessGetStaticPropsPropsContext​

Ƭ HeadlessGetStaticPropsPropsContext<Q>: GetStaticPropsContext<Q, PreviewData>

Type parameters​

NameType
Qextends ParsedUrlQuery = ParsedUrlQuery

Defined in​

packages/next/src/data/types.ts:13

HookState​

Ƭ HookState<T>: Object

Type parameters​

Name
T

Type declaration​

NameType
additionalCacheObjects?HookState<T>[]
dataT
isMainQueryboolean
keystring

Defined in​

packages/next/src/data/server/addHookData.ts:10

NextJSProps​

Ƭ NextJSProps<P>: Object

Type parameters​

Name
P

Type declaration​

NameType
notFound?boolean
props?P
redirect?Redirect
revalidate?number | boolean

Defined in​

packages/next/src/data/server/addHookData.ts:17

PreviewData​

Ƭ PreviewData: Object

The shape of the preview data that's stored in the preview data cookie

Index signature​

▪ [k: string]: unknown

Type declaration​

NameTypeDescription
authTokenstringThe auth token that should be used to fetch the data
idnumberThe id of the resource
postTypestringThe post type
revisionbooleanWhether the preview data is on a revision

Defined in​

packages/next/src/handlers/types.ts:4

PreviewHandlerOptions​

Ƭ PreviewHandlerOptions: Object

The options supported by previewHandler

Type declaration​

NameType
getRedirectPath?(defaultRedirectPath: string, post: any, postTypeDef: CustomPostType) => string
onRedirect?(req: NextApiRequest, res: NextApiResponse, previewData: PreviewData, defaultRedirect?: PreviewHandlerOptions["onRedirect"], redirectpath?: string) => void
preparePreviewData?(req: NextApiRequest, res: NextApiResponse, post: PostEntity, previewData: PreviewData) => PreviewData

Defined in​

packages/next/src/handlers/previewHandler.ts:11

VIPCustomImageLoader​

Ƭ VIPCustomImageLoader: ImageLoaderProps & { aspectRatio?: string }

Defined in​

packages/next/src/components/ImageComponent.tsx:30

seoKey​

• Const seoKey: "@seo"

Defined in​

packages/next/src/data/hooks/useSeo.ts:3

VIPImageLoader​

▸ VIPImageLoader(props): string

Custom Image loader for WordPress VIP leveraging Photon's API. This can't be made -a global loader because of the local loader used on the custom image component.

Parameters​

NameTypeDescription
propsVIPCustomImageLoaderThe loader props

Returns​

string

Defined in​

packages/next/src/components/ImageComponent.tsx:42

convertUrl​

▸ convertUrl(url, hostUrl, sourceUrl): string

Parameters​

NameType
urlstring
hostUrlstring
sourceUrlstring

Returns​

string

Defined in​

packages/next/src/components/Yoast.tsx:15

getPathName​

▸ getPathName(resolvedUrl): string

Extracts the path name out of the Next.js resolvedUrl

Parameters​

NameTypeDescription
resolvedUrlstringThe full resolved URL

Returns​

string

Defined in​

packages/next/src/data/server/handleError.ts:23

getSiteFromContext​

▸ getSiteFromContext(ctx): HeadlessConfig | { customPostTypes: CustomPostTypes ; customTaxonomies: CustomTaxonomies ; debug: undefined | { devMode?: boolean ; redirects?: boolean ; requests?: boolean } ; hostUrl: string ; integrations: undefined | Integrations ; preview: undefined | PreviewConfig ; redirectStrategy: RedirectStrategy ; sites: HeadlessConfig[] ; sourceUrl: undefined | string ; useWordPressPlugin: boolean }

Get site using context

Parameters​

NameType
ctxGetServerSidePropsContext<ParsedUrlQuery, PreviewData> | GetStaticPropsContext<ParsedUrlQuery, PreviewData>

Returns​

HeadlessConfig | { customPostTypes: CustomPostTypes ; customTaxonomies: CustomTaxonomies ; debug: undefined | { devMode?: boolean ; redirects?: boolean ; requests?: boolean } ; hostUrl: string ; integrations: undefined | Integrations ; preview: undefined | PreviewConfig ; redirectStrategy: RedirectStrategy ; sites: HeadlessConfig[] ; sourceUrl: undefined | string ; useWordPressPlugin: boolean }

HeadlessConfig

Defined in​

packages/next/src/data/server/getSiteFromContext.ts:10

usePrepareFetch​

▸ usePrepareFetch<T, P>(_params?, options?): Object

Prepares params and options for useFetch hooks

Type parameters​

NameType
Textends Entity | Entity[]
Pextends EndpointParams

Parameters​

NameTypeDescription
_paramsPartial<P>The fetch params
optionsFetchHookOptions<FetchResponse<T>>The fetch options

Returns​

Object

NameType
optionsFetchHookOptions<FetchResponse<T>>
paramsPartial<P>
pathstring

Defined in​

packages/next/src/data/hooks/usePrepareFetch.ts:13

React Components​

HeadlessApp​

▸ HeadlessApp(props): Element

The HeadlessApp component is the top level component for the Headless framework.

Should be used in pages/_app.js

Usage​

import { HeadlessApp } from "@headstartwp/next";

const MyApp = ({ Component, pageProps }) => {
    const { fallback = {}, themeJson = {}, ...props } = pageProps;

    return (
        <HeadlessApp
            pageProps={pageProps}
            settings={{
                // Pass your own link components here
                linkComponent: Link,
            }}
        >
            <Layout>
                <Component {...props} />
            </Layout>
        </HeadlessApp>
    );
};

export default MyApp;

Parameters​

NameTypeDescription
propsHeadlessAppPropsComponent props. See HeadlessAppProps

Returns​

Element

Defined in​

packages/next/src/components/HeadlessApp.tsx:96

ImageComponent​

▸ ImageComponent(props): Element

An implementation of the ImageBlock (core/image).

If width, height or src are not provided, this component will not be used.

Usage​

import { BlocksRenderer, ImageBlock } from "@headstartwp/core/react";
import { ImageComponent } from "@headstartwp/next";

<BlocksRenderer html={html}>
    <ImageBlock component={ImageComponent} />
</BlocksRenderer>

Parameters​

NameTypeDescription
propsImagePropsImageBlockProps

Returns​

Element

Defined in​

packages/next/src/components/ImageComponent.tsx:98

LinkBlock​

▸ LinkBlock(props): Element

The Link Block converts a anchor tag node into a next/link component if it's an internal link

Usage​

import { BlocksRenderer } from "@headstartwp/core/react";
import { LinkBlock } from "@headstartwp/next";

<BlocksRenderer html={html}>
    <LinkBlock />
</BlocksRenderer>

Parameters​

NameTypeDescription
propsOmit<IBlock<LinkBlockProps>, "component">Link Block Props

Returns​

Element

The next/link component

Defined in​

packages/next/src/blocks/LinkBlock.tsx:33

TwitterBlock​

▸ TwitterBlock(props): Element

Renders a twitter embed

Usage​

import { BlocksRenderer } from "@headstartwp/core/react";
import { TwitterBlock } from "@headstartwp/next";

<BlocksRenderer html={html}>
    <TwitterBlock />
</BlocksRenderer>

Parameters​

NameTypeDescription
propsOmit<IBlock<IBlockAttributes>, "component">Link Block Props

Returns​

Element

Defined in​

packages/next/src/blocks/TwitterBlock.tsx:25

Yoast​

▸ Yoast(props): Element

The Yoast component renders the Yoast SEO meta tags. -This component is automatically rendered by HeadlessApp so you don't have to manually render it.

Parameters​

NameTypeDescription
propsPropsComponent props. Expects a single seo prop

Returns​

Element

Defined in​

packages/next/src/components/Yoast.tsx:63

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

Finely crafted by 10up, ©2023.

- - +return a server error (500) page

Usage​

export async function getServerSideProps(context) {
    try {
        const usePostsHook = await fetchHookData(usePosts.fetcher(),context);
        return addHookData([usePostsHook], {});
    } catch (e) {
        return handleError(e, context);
    }
}

Parameters​

NameTypeDefault valueDescription
errorErrorundefinedThe error object
ctxHeadlessGetServerSidePropsContext<ParsedUrlQuery> | HeadlessGetStaticPropsPropsContext<ParsedUrlQuery>undefinedThe Next.js context
rootRoutestring''The root route (deprecated/unnecessary). This needs to be revisited

Returns​

Promise<GetServerSidePropsResult<{}>>

Defined in​

packages/next/src/data/server/handleError.ts:62

Other​

HeadlessAppProps​

Ƭ HeadlessAppProps: Object

The props supported by HeadlessApp.

Type declaration​

NameTypeDescription
children?ReactNode-
handleYoast?booleanIf true, will automatically load yoast seo metadata into the head Default true
pagePropsanyThe 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
settingsSettingsContextPropsSupported settings by the framework. Such as custom image component, custom link component etc. See SettingsContextProps
swrConfigDataFetchingProviderProps["swrConfig"]Pass any configuration to the SWR library. Globally. These settings can be overridden at the hook level.
useYoastHtml?booleanIf 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.

Defined in​

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

HeadlessGetServerSideProps​

Ƭ HeadlessGetServerSideProps<P, Q>: GetServerSideProps<P, Q, PreviewData>

Type parameters​

NameType
Pextends Object = { [key: string]: any; }
Qextends ParsedUrlQuery = ParsedUrlQuery

Defined in​

packages/next/src/data/types.ts:16

HeadlessGetServerSidePropsContext​

Ƭ HeadlessGetServerSidePropsContext<Q>: GetServerSidePropsContext<Q, PreviewData>

Type parameters​

NameType
Qextends ParsedUrlQuery = ParsedUrlQuery

Defined in​

packages/next/src/data/types.ts:10

HeadlessGetStaticProps​

Ƭ HeadlessGetStaticProps<P, Q>: GetStaticProps<P, Q, PreviewData>

Type parameters​

NameType
Pextends Object = { [key: string]: any; }
Qextends ParsedUrlQuery = ParsedUrlQuery

Defined in​

packages/next/src/data/types.ts:21

HeadlessGetStaticPropsPropsContext​

Ƭ HeadlessGetStaticPropsPropsContext<Q>: GetStaticPropsContext<Q, PreviewData>

Type parameters​

NameType
Qextends ParsedUrlQuery = ParsedUrlQuery

Defined in​

packages/next/src/data/types.ts:13

HookState​

Ƭ HookState<T>: Object

Type parameters​

Name
T

Type declaration​

NameType
additionalCacheObjects?HookState<T>[]
dataT
isMainQueryboolean
keystring

Defined in​

packages/next/src/data/server/addHookData.ts:10

NextJSProps​

Ƭ NextJSProps<P>: Object

Type parameters​

Name
P

Type declaration​

NameType
notFound?boolean
props?P
redirect?Redirect
revalidate?number | boolean

Defined in​

packages/next/src/data/server/addHookData.ts:17

PreviewData​

Ƭ PreviewData: Object

The shape of the preview data that's stored in the preview data cookie

Index signature​

▪ [k: string]: unknown

Type declaration​

NameTypeDescription
authTokenstringThe auth token that should be used to fetch the data
idnumberThe id of the resource
postTypestringThe post type
revisionbooleanWhether the preview data is on a revision

Defined in​

packages/next/src/handlers/types.ts:4

PreviewHandlerOptions​

Ƭ PreviewHandlerOptions: Object

The options supported by previewHandler

Type declaration​

NameType
getRedirectPath?(defaultRedirectPath: string, post: any, postTypeDef: CustomPostType) => string
onRedirect?(req: NextApiRequest, res: NextApiResponse, previewData: PreviewData, defaultRedirect?: PreviewHandlerOptions["onRedirect"], redirectpath?: string) => void
preparePreviewData?(req: NextApiRequest, res: NextApiResponse, post: PostEntity, previewData: PreviewData) => PreviewData

Defined in​

packages/next/src/handlers/previewHandler.ts:11

VIPCustomImageLoader​

Ƭ VIPCustomImageLoader: ImageLoaderProps & { aspectRatio?: string }

Defined in​

packages/next/src/components/ImageComponent.tsx:30

seoKey​

• Const seoKey: "@seo"

Defined in​

packages/next/src/data/hooks/useSeo.ts:3

VIPImageLoader​

▸ VIPImageLoader(props): string

Custom Image loader for WordPress VIP leveraging Photon's API. This can't be made +a global loader because of the local loader used on the custom image component.

Parameters​

NameTypeDescription
propsVIPCustomImageLoaderThe loader props

Returns​

string

Defined in​

packages/next/src/components/ImageComponent.tsx:42

convertUrl​

▸ convertUrl(url, hostUrl, sourceUrl): string

Parameters​

NameType
urlstring
hostUrlstring
sourceUrlstring

Returns​

string

Defined in​

packages/next/src/components/Yoast.tsx:15

getPathName​

▸ getPathName(resolvedUrl): string

Extracts the path name out of the Next.js resolvedUrl

Parameters​

NameTypeDescription
resolvedUrlstringThe full resolved URL

Returns​

string

Defined in​

packages/next/src/data/server/handleError.ts:23

getSiteFromContext​

▸ getSiteFromContext(ctx): HeadlessConfig | { customPostTypes: CustomPostTypes ; customTaxonomies: CustomTaxonomies ; debug: undefined | { devMode?: boolean ; redirects?: boolean ; requests?: boolean } ; hostUrl: string ; integrations: undefined | Integrations ; preview: undefined | PreviewConfig ; redirectStrategy: RedirectStrategy ; sites: HeadlessConfig[] ; sourceUrl: undefined | string ; useWordPressPlugin: boolean }

Get site using context

Parameters​

NameType
ctxGetServerSidePropsContext<ParsedUrlQuery, PreviewData> | GetStaticPropsContext<ParsedUrlQuery, PreviewData>

Returns​

HeadlessConfig | { customPostTypes: CustomPostTypes ; customTaxonomies: CustomTaxonomies ; debug: undefined | { devMode?: boolean ; redirects?: boolean ; requests?: boolean } ; hostUrl: string ; integrations: undefined | Integrations ; preview: undefined | PreviewConfig ; redirectStrategy: RedirectStrategy ; sites: HeadlessConfig[] ; sourceUrl: undefined | string ; useWordPressPlugin: boolean }

HeadlessConfig

Defined in​

packages/next/src/data/server/getSiteFromContext.ts:10

prepareFetchHookData​

▸ prepareFetchHookData<T, P, R>(fetchStrategy, ctx, options?): Object

Prepares all the things for fetchHookData

Type parameters​

NameType
Tunknown
Pextends EndpointParams = EndpointParams
RT

Parameters​

NameTypeDescription
fetchStrategyAbstractFetchStrategy<T, P, R>The fetch strategy to use. Typically this is exposed by the hook e.g: usePosts.fetcher()
ctxGetServerSidePropsContext<any, PreviewData> | GetStaticPropsContext<any, PreviewData>The Next.js context, either the one from getServerSideProps or getStaticProps
optionsFetchHookDataOptions<P, T>See FetchHookDataOptions

Returns​

Object

The various things fetchHookData needs

NameType
cacheKey{ args: Partial<P> & { sourceUrl: string } ; url: string }
cacheKey.argsPartial<P> & { sourceUrl: string }
cacheKey.urlstring
paramsPartial<P>
pathstring
urlParamsPartial<P>

Defined in​

packages/next/src/data/server/fetchHookData.ts:61

usePrepareFetch​

▸ usePrepareFetch<T, P>(_params?, options?): Object

Prepares params and options for useFetch hooks

Type parameters​

NameType
Textends Entity | Entity[]
Pextends EndpointParams

Parameters​

NameTypeDescription
_paramsPartial<P>The fetch params
optionsFetchHookOptions<FetchResponse<T>>The fetch options

Returns​

Object

NameType
optionsFetchHookOptions<FetchResponse<T>>
paramsPartial<P>
pathstring

Defined in​

packages/next/src/data/hooks/usePrepareFetch.ts:13

React Components​

HeadlessApp​

▸ HeadlessApp(props): Element

The HeadlessApp component is the top level component for the Headless framework.

Should be used in pages/_app.js

Usage​

import { HeadlessApp } from "@headstartwp/next";

const MyApp = ({ Component, pageProps }) => {
    const { fallback = {}, themeJson = {}, ...props } = pageProps;

    return (
        <HeadlessApp
            pageProps={pageProps}
            settings={{
                // Pass your own link components here
                linkComponent: Link,
            }}
        >
            <Layout>
                <Component {...props} />
            </Layout>
        </HeadlessApp>
    );
};

export default MyApp;

Parameters​

NameTypeDescription
propsHeadlessAppPropsComponent props. See HeadlessAppProps

Returns​

Element

Defined in​

packages/next/src/components/HeadlessApp.tsx:96

ImageComponent​

▸ ImageComponent(props): Element

An implementation of the ImageBlock (core/image).

If width, height or src are not provided, this component will not be used.

Usage​

import { BlocksRenderer, ImageBlock } from "@headstartwp/core/react";
import { ImageComponent } from "@headstartwp/next";

<BlocksRenderer html={html}>
    <ImageBlock component={ImageComponent} />
</BlocksRenderer>

Parameters​

NameTypeDescription
propsImagePropsImageBlockProps

Returns​

Element

Defined in​

packages/next/src/components/ImageComponent.tsx:98

LinkBlock​

▸ LinkBlock(props): Element

The Link Block converts a anchor tag node into a next/link component if it's an internal link

Usage​

import { BlocksRenderer } from "@headstartwp/core/react";
import { LinkBlock } from "@headstartwp/next";

<BlocksRenderer html={html}>
    <LinkBlock />
</BlocksRenderer>

Parameters​

NameTypeDescription
propsOmit<IBlock<LinkBlockProps>, "component">Link Block Props

Returns​

Element

The next/link component

Defined in​

packages/next/src/blocks/LinkBlock.tsx:33

TwitterBlock​

▸ TwitterBlock(props): Element

Renders a twitter embed

Usage​

import { BlocksRenderer } from "@headstartwp/core/react";
import { TwitterBlock } from "@headstartwp/next";

<BlocksRenderer html={html}>
    <TwitterBlock />
</BlocksRenderer>

Parameters​

NameTypeDescription
propsOmit<IBlock<IBlockAttributes>, "component">Link Block Props

Returns​

Element

Defined in​

packages/next/src/blocks/TwitterBlock.tsx:25

Yoast​

▸ Yoast(props): Element

The Yoast component renders the Yoast SEO meta tags. +This component is automatically rendered by HeadlessApp so you don't have to manually render it.

Parameters​

NameTypeDescription
propsPropsComponent props. Expects a single seo prop

Returns​

Element

Defined in​

packages/next/src/components/Yoast.tsx:63

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/namespaces/headstartwp_core.react/index.html b/api/namespaces/headstartwp_core.react/index.html index d6adc2045..bff0334e3 100644 --- a/api/namespaces/headstartwp_core.react/index.html +++ b/api/namespaces/headstartwp_core.react/index.html @@ -7,17 +7,17 @@ - - + +
-
Skip to main content

Namespace: react

@headstartwp/core.react

@headstartwp/core/react​

The react export of the @headstartwp/core package.

Usage​

import { BlocksRenderer } from "@headstartwp/core/react";

Interfaces​

Blocks​

AudioBlock​

▸ AudioBlock(props): Element

The AudioBlock components implements block parsing for the Audio block.

This component must be used within a BlocksRenderer component.

<BlocksRenderer html={html}>
    <AudioBlock component={DebugComponent} />
</BlocksRenderer>

Parameters​

NameTypeDescription
propsIAudioBlockComponent properties

Returns​

Element

Defined in​

packages/core/src/react/blocks/AudioBlock.tsx:58

ButtonBlock​

▸ ButtonBlock(props): Element

The ButtonBlock component implements block parsing for the Button block.

This component must be used within a BlocksRenderer component.

<BlocksRenderer html={html}>
    <ButtonBlock component={DebugComponent} />
</BlocksRenderer>

Parameters​

NameTypeDescription
propsIButtonBlockComponent properties

Returns​

Element

Defined in​

packages/core/src/react/blocks/ButtonBlock.tsx:62

ButtonsBlock​

▸ ButtonsBlock(props): Element

The ButtonsBlock component implements block parsing for the Buttons block.

This component must be used within a BlocksRenderer component.

<BlocksRenderer html={html}>
    <ButtonsBlock component={DebugComponent} />
</BlocksRenderer>

Parameters​

NameTypeDescription
propsIButtonsBlockComponent properties

Returns​

Element

Defined in​

packages/core/src/react/blocks/ButtonsBlock.tsx:28

CodeBlock​

▸ CodeBlock(props): Element

The CodeBlock component implements block parsing for the core/code block.

This component must be used within a BlocksRenderer component.

<BlocksRenderer html={html}>
    <CodeBlock component={DebugComponent} />
</BlocksRenderer>

Parameters​

NameTypeDescription
propsICodeBlockComponent properties

Returns​

Element

Defined in​

packages/core/src/react/blocks/CodeBlock.tsx:32

Data Fetching Hooks​

useFetch​

▸ useFetch<E, Params, R>(params, fetchStrategy, options?, path?): Object

The use Fetch Hook is the foundation for most hooks in the headless framework. It is a wrapper around +

Namespace: react

@headstartwp/core.react

@headstartwp/core/react​

The react export of the @headstartwp/core package.

Usage​

import { BlocksRenderer } from "@headstartwp/core/react";

Interfaces​

Blocks​

AudioBlock​

▸ AudioBlock(props): Element

The AudioBlock components implements block parsing for the Audio block.

This component must be used within a BlocksRenderer component.

<BlocksRenderer html={html}>
    <AudioBlock component={DebugComponent} />
</BlocksRenderer>

Parameters​

NameTypeDescription
propsIAudioBlockComponent properties

Returns​

Element

Defined in​

packages/core/src/react/blocks/AudioBlock.tsx:58

ButtonBlock​

▸ ButtonBlock(props): Element

The ButtonBlock component implements block parsing for the Button block.

This component must be used within a BlocksRenderer component.

<BlocksRenderer html={html}>
    <ButtonBlock component={DebugComponent} />
</BlocksRenderer>

Parameters​

NameTypeDescription
propsIButtonBlockComponent properties

Returns​

Element

Defined in​

packages/core/src/react/blocks/ButtonBlock.tsx:62

ButtonsBlock​

▸ ButtonsBlock(props): Element

The ButtonsBlock component implements block parsing for the Buttons block.

This component must be used within a BlocksRenderer component.

<BlocksRenderer html={html}>
    <ButtonsBlock component={DebugComponent} />
</BlocksRenderer>

Parameters​

NameTypeDescription
propsIButtonsBlockComponent properties

Returns​

Element

Defined in​

packages/core/src/react/blocks/ButtonsBlock.tsx:28

CodeBlock​

▸ CodeBlock(props): Element

The CodeBlock component implements block parsing for the core/code block.

This component must be used within a BlocksRenderer component.

<BlocksRenderer html={html}>
    <CodeBlock component={DebugComponent} />
</BlocksRenderer>

Parameters​

NameTypeDescription
propsICodeBlockComponent properties

Returns​

Element

Defined in​

packages/core/src/react/blocks/CodeBlock.tsx:32

Data Fetching Hooks​

useFetch​

▸ useFetch<E, Params, R>(params, fetchStrategy, options?, path?): Object

The use Fetch Hook is the foundation for most hooks in the headless framework. It is a wrapper around useSWR and provides a consistent API for fetching data from the API. It requires a fetch strategy which implements -the actual data fetching logic

Type parameters​

NameType
EE
Paramsextends EndpointParams
RE

Parameters​

NameTypeDefault valueDescription
params{} | ParamsundefinedThe list of params to pass to the fetch strategy. It overrides the ones in the URL.
fetchStrategyAbstractFetchStrategy<E, Params, R>undefinedThe fetch strategy.
optionsFetchHookOptions<FetchResponse<R>>{}The options to pass to the swr hook.
pathstring''The path of the url to get url params from.

Returns​

Object

NameTypeDescription
dataundefined | FetchResponse<R>The returned data of the fetcher function.
erroranyThe error object thrown by the fetcher function.
isLoadingboolean-
isMainQueryboolean-
isValidatingboolean-
mutateKeyedMutator<FetchResponse<R>>-
paramsPartial<Params>-

Defined in​

packages/core/src/react/hooks/useFetch.ts:30

useFetchAppSettings​

▸ useFetchAppSettings<T, P>(params?, options?): useAppSettingsResponse<T>

The useAppSettings hook

See useAppSettings

Type parameters​

NameType
Textends AppEntity = AppEntity
Pextends EndpointParams = EndpointParams

Parameters​

NameTypeDescription
params{} | PThe list of params to pass to the fetch strategy. It overrides the ones in the URL.
optionsFetchHookOptions<FetchResponse<T>>The options to pass to the swr hook.

Returns​

useAppSettingsResponse<T>

Defined in​

packages/core/src/react/hooks/useFetchAppSettings.ts:21

useFetchMenu​

▸ useFetchMenu(menuLocation, options?): useMenuResponse

The useFetchMenu hooks. Returns a Menu object.

Parameters​

NameTypeDescription
menuLocationstringThe slug of the menu location you want to fetch
optionsFetchHookOptions<FetchResponse<AppEntity>>SWR configuration options

Returns​

useMenuResponse

Defined in​

packages/core/src/react/hooks/useFetchMenu.ts:50

useFetchPosts​

▸ useFetchPosts<T, P>(params?, options?, path?, fetcher?): usePostsResponse<T>

The useFetchPosts hook. Returns a collection of post entities

See usePosts for usage instructions.

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters​

NameTypeDefault valueDescription
params{} | P{}The list of params to pass to the fetch strategy. It overrides the ones in the URL.
optionsFetchHookOptions<FetchResponse<T[]>>{}The options to pass to the swr hook.
pathstring''The path of the url to get url params from.
fetcherundefined | PostsArchiveFetchStrategy<T, P>undefinedThe fetch strategy to use. If none is passed, the default one is used

Returns​

usePostsResponse<T>

Defined in​

packages/core/src/react/hooks/useFetchPosts.ts:79

useFetchSearch​

▸ useFetchSearch<T, P>(params?, options?, path?): useSearchResponse<T>

The useFetchSearch hook. Returns a collection of post entities

See useSearch for usage instructions.

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters​

NameTypeDefault valueDescription
params{} | P{}The list of params to pass to the fetch strategy. It overrides the ones in the URL.
optionsFetchHookOptions<FetchResponse<T[]>>{}The options to pass to the swr hook.
pathstring''The path of the url to get url params from.

Returns​

useSearchResponse<T>

Defined in​

packages/core/src/react/hooks/useFetchSearch.ts:32

useFetchSearchNative​

▸ useFetchSearchNative<T, P>(params?, options?, path?): useSearchNativeResponse<T>

The useFetchSearchNative hook. Returns a collection of search entities retrieved through the WP native search endpoint

See useSearchNative for usage instructions.

Type parameters​

NameType
Textends PostSearchEntity | TermSearchEntity = PostSearchEntity | TermSearchEntity
Pextends SearchParams = SearchParams

Parameters​

NameTypeDefault valueDescription
params{} | P{}The list of params to pass to the fetch strategy. It overrides the ones in the URL.
optionsFetchHookOptions<FetchResponse<T[]>>{}The options to pass to the swr hook.
pathstring''The path of the url to get url params from.

Returns​

useSearchNativeResponse<T>

Defined in​

packages/core/src/react/hooks/useFetchSearchNative.ts:35

useFetchTerms​

▸ useFetchTerms<T, P>(params, options?, path?): useTermsResponse<T>

The useFetchTerms hook. Returns a collection of term entities

See useTerms for usage instructions.

Type parameters​

NameType
Textends TermEntity = TermEntity
Pextends TaxonomyArchiveParams = TaxonomyArchiveParams

Parameters​

NameTypeDefault valueDescription
params{} | PundefinedThe list of params to pass to the fetch strategy. It overrides the ones in the URL.
optionsFetchHookOptions<FetchResponse<T[]>>{}The options to pass to the swr hook.
pathstring''The path of the url to get url params from.

Returns​

useTermsResponse<T>

Defined in​

packages/core/src/react/hooks/useFetchTerms.ts:29

Other​

Align​

Ƭ Align: "none" | "left" | "center" | "right" | "wide" | "full"

Defined in​

packages/core/src/react/blocks/types.ts:15

Border​

Ƭ Border: Object

Type declaration​

NameType
radius?string
style?string
width?string

Defined in​

packages/core/src/react/blocks/types.ts:65

DataFetchingProviderProps​

Ƭ DataFetchingProviderProps: Object

Type declaration​

NameTypeDescription
dataSWRConfiguration["fallback"]-
swrConfigSWRConfigurationPass any configuration to the SWR library. Globally. These settings can be overridden at the hook level.

Defined in​

packages/core/src/react/provider/DataFetchingProvider.tsx:6

ItemWrapper​

Ƭ ItemWrapper: (props: ItemWrapperProps) => JSX.Element

Type declaration​

▸ (props): JSX.Element

Parameters​
NameType
propsItemWrapperProps
Returns​

JSX.Element

Defined in​

packages/core/src/react/components/Menu.tsx:15

ItemWrapperProps​

Ƭ ItemWrapperProps: PropsWithChildren<{ className: string ; depth: number ; item: MenuItemEntity }>

Defined in​

packages/core/src/react/components/Menu.tsx:10

Ƭ LinkWrapper: (props: LinkWrapperProps) => JSX.Element

Type declaration​

▸ (props): JSX.Element

Parameters​
NameType
propsLinkWrapperProps
Returns​

JSX.Element

Defined in​

packages/core/src/react/components/Menu.tsx:27

LinkWrapperProps​

Ƭ LinkWrapperProps: PropsWithChildren<{ depth: number ; href: string }>

Defined in​

packages/core/src/react/components/Menu.tsx:23

Ƭ MenuItemsProp: Object

Type declaration​

NameType
depthnumber
itemWrapperItemWrapper
itemsMenuItemEntity[]
linkWrapperLinkWrapper
menuWrapperMenuWrapper
topLevelItemsClickableboolean

Defined in​

packages/core/src/react/components/Menu.tsx:29

Ƭ MenuWrapper: (props: MenuWrapperProps) => JSX.Element

Type declaration​

▸ (props): JSX.Element

Parameters​
NameType
propsMenuWrapperProps
Returns​

JSX.Element

Defined in​

packages/core/src/react/components/Menu.tsx:21

Ƭ MenuWrapperProps: PropsWithChildren<{ className: string ; depth: number }>

Defined in​

packages/core/src/react/components/Menu.tsx:17

PageType​

Ƭ PageType: Object

Type declaration​

NameTypeDescription
isAuthorArchivebooleanAuthor Archive
isCategoryArchivebooleanCategory Archive
isPostArchivebooleanRegular post archive
isPostTypeArchivebooleanCustom Post Type Archive
isSearchbooleanSearch route
isTagArchivebooleanTag Archive
isTaxonomyArchivebooleanCustom Taxonomy Archive
postTypestringWhich post type this archive is for
taxonomystringWhich taxonomy this archive is for

Defined in​

packages/core/src/react/hooks/useFetchPosts.ts:19

SettingsColorPalette​

Ƭ SettingsColorPalette: Object

Type declaration​

NameType
default?SettingsColorPreset[]
theme?SettingsColorPreset[]
user?SettingsColorPreset[]

Defined in​

packages/core/src/react/provider/types.ts:47

SettingsColorPreset​

Ƭ SettingsColorPreset: Object

Type declaration​

NameTypeDescription
colorstringCSS hex or rgb(a) string.
namestringName of the color preset, translatable.
slugstringKebab-case unique identifier for the color preset.

Defined in​

packages/core/src/react/provider/types.ts:32

SettingsContextProps​

Ƭ SettingsContextProps: { imageComponent?: React.FC<IImageBlock> ; linkComponent?: ReactNode } & HeadlessConfig

Defined in​

packages/core/src/react/provider/types.ts:5

SettingsDuotone​

Ƭ SettingsDuotone: Object

Type declaration​

NameType
default?SettingsDuotonePreset[]
theme?SettingsDuotonePreset[]
user?SettingsDuotonePreset[]

Defined in​

packages/core/src/react/provider/types.ts:89

SettingsDuotonePreset​

Ƭ SettingsDuotonePreset: Object

Type declaration​

NameTypeDescription
colorsstring[]List of colors from dark to light.
namestringName of the duotone preset, translatable.
slugstringKebab-case unique identifier for the duotone preset.

Defined in​

packages/core/src/react/provider/types.ts:74

SettingsGradient​

Ƭ SettingsGradient: Object

Type declaration​

NameType
default?SettingsGradientPreset[]
theme?SettingsGradientPreset[]
user?SettingsGradientPreset[]

Defined in​

packages/core/src/react/provider/types.ts:68

SettingsGradientPreset​

Ƭ SettingsGradientPreset: Object

Type declaration​

NameTypeDescription
gradientstringCSS gradient string.
namestringName of the gradient preset, translatable.
slugstringKebab-case unique identifier for the gradient preset.

Defined in​

packages/core/src/react/provider/types.ts:53

SettingsPropertiesComplete​

Ƭ SettingsPropertiesComplete: SettingsProperties & { border?: SettingsProperties["border"] ; color?: SettingsProperties["color"] ; custom?: SettingsProperties["custom"] ; layout?: SettingsProperties["layout"] ; spacing?: SettingsProperties["spacing"] ; typography?: SettingsProperties["typography"] }

Defined in​

packages/core/src/react/provider/types.ts:10

Spacing​

Ƭ Spacing: Object

Type declaration​

NameType
blockGapstring
margin{ bottom: string ; left: string ; right: string ; top: string }
margin.bottomstring
margin.leftstring
margin.rightstring
margin.topstring
padding{ bottom: string ; left: string ; right: string ; top: string }
padding.bottomstring
padding.leftstring
padding.rightstring
padding.topstring
supportsBlockGapboolean
supportsMarginboolean
supportsPaddingboolean

Defined in​

packages/core/src/react/blocks/types.ts:40

Style​

Ƭ Style: Object

Type declaration​

NameType
borderBorder
spacingSpacing
typographyTypography

Defined in​

packages/core/src/react/blocks/types.ts:17

StylesPropertiesAndElementsComplete​

Ƭ StylesPropertiesAndElementsComplete: StylesProperties & { border?: SettingsProperties["border"] ; color?: SettingsProperties["color"] ; elements?: StylesElementsPropertiesComplete ; spacing?: SettingsProperties["spacing"] ; typography?: SettingsProperties["typography"] }

Defined in​

packages/core/src/react/provider/types.ts:24

StylesPropertiesComplete​

Ƭ StylesPropertiesComplete: StylesProperties & { border?: SettingsProperties["border"] ; color?: SettingsProperties["color"] ; spacing?: SettingsProperties["spacing"] ; typography?: SettingsProperties["typography"] }

Defined in​

packages/core/src/react/provider/types.ts:18

ThemeJSON​

Ƭ ThemeJSON: Pick<WpThemeJSON, "styles" | "settings">

Defined in​

packages/core/src/react/provider/types.ts:352

SettingsContext​

• Const SettingsContext: Context<Partial<SettingsContextProps>>

Defined in​

packages/core/src/react/provider/Provider.tsx:5

ThemeSettingsContext​

• Const ThemeSettingsContext: Context<ThemeJSON>

Defined in​

packages/core/src/react/provider/ThemeSettingsProvider.tsx:4

defaultElement​

• Const defaultElement: Element

Defined in​

packages/core/src/react/blocks/hooks/useBlock.ts:8

ColumnBlock​

▸ ColumnBlock(«destructured»): Element

Parameters​

NameType
«destructured»IColumnBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/ColumnBlock.tsx:11

ColumnsBlock​

▸ ColumnsBlock(«destructured»): Element

Parameters​

NameType
«destructured»IColumnsBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/ColumnsBlocks.tsx:11

CoverBlock​

▸ CoverBlock(«destructured»): Element

Parameters​

NameType
«destructured»ICoverBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/CoverBlock.tsx:24

DataFetchingProvider​

▸ DataFetchingProvider(props, context?): null | ReactElement<any, any>

Parameters​

NameType
propsPropsWithChildren<DataFetchingProviderProps>
context?any

Returns​

null | ReactElement<any, any>

Defined in​

node_modules/@types/react/index.d.ts:542

DebugBlock​

▸ DebugBlock(«destructured»): Element

Parameters​

NameType
«destructured»Object

Returns​

Element

Defined in​

packages/core/src/react/blocks/DebugBlock.tsx:7

FileBlock​

▸ FileBlock(«destructured»): Element

Parameters​

NameType
«destructured»IFileBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/FileBlock.tsx:14

GroupBlock​

▸ GroupBlock(«destructured»): Element

Parameters​

NameType
«destructured»IGroupBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/GroupBlock.tsx:17

HeadingBlock​

▸ HeadingBlock(«destructured»): Element

Parameters​

NameType
«destructured»IHeadingBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/HeadingBlock.tsx:12

ImageBlock​

▸ ImageBlock(«destructured»): Element

Parameters​

NameType
«destructured»IImageBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/ImageBlock.tsx:19

ListBlock​

▸ ListBlock(«destructured»): Element

Parameters​

NameType
«destructured»IListBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/ListBlock.tsx:12

MediaTextBlock​

▸ MediaTextBlock(«destructured»): Element

Parameters​

NameType
«destructured»IMediaTextBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/MediaTextBlock.tsx:22

▸ Menu(«destructured»): Element

Parameters​

NameType
«destructured»MenuProps

Returns​

Element

Defined in​

packages/core/src/react/components/Menu.tsx:109

▸ MenuItems(«destructured»): Element

Parameters​

NameType
«destructured»MenuItemsProp

Returns​

Element

Defined in​

packages/core/src/react/components/Menu.tsx:54

ParagraphBlock​

▸ ParagraphBlock(«destructured»): Element

Parameters​

NameType
«destructured»IParagraphBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/ParagraphBlock.tsx:13

PreformattedBlock​

▸ PreformattedBlock(«destructured»): Element

Parameters​

NameType
«destructured»IPreformattedBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/PreformatedBlock.tsx:11

PullQuoteBlock​

▸ PullQuoteBlock(«destructured»): Element

Parameters​

NameType
«destructured»IPullQuoteBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/PullQuote.tsx:15

QuoteBlock​

▸ QuoteBlock(«destructured»): Element

Parameters​

NameType
«destructured»IQuoteBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/QuoteBlock.tsx:10

SeparatorBlock​

▸ SeparatorBlock(«destructured»): Element

Parameters​

NameType
«destructured»ISeparatorBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/SeparatorBlock.tsx:10

SettingsProvider​

▸ SettingsProvider(props, context?): null | ReactElement<any, any>

Parameters​

NameType
propsPropsWithChildren<ProviderProps>
context?any

Returns​

null | ReactElement<any, any>

Defined in​

node_modules/@types/react/index.d.ts:542

SpacerBlock​

▸ SpacerBlock(«destructured»): Element

Parameters​

NameType
«destructured»ISpacerBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/SpacerBlock.tsx:12

TableBlock​

▸ TableBlock(«destructured»): Element

Parameters​

NameType
«destructured»ITableBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/TableBlock.tsx:12

ThemeSettingsProvider​

▸ ThemeSettingsProvider(props, context?): null | ReactElement<any, any>

Parameters​

NameType
propsPropsWithChildren<ProviderProps>
context?any

Returns​

null | ReactElement<any, any>

Defined in​

node_modules/@types/react/index.d.ts:542

VerseBlock​

▸ VerseBlock(«destructured»): Element

Parameters​

NameType
«destructured»IVerseBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/VerseBlock.tsx:11

YoutubeLiteBlock​

▸ YoutubeLiteBlock(props): Element

Renders Youtube embeds with lite-youtube-embed

Parameters​

NameTypeDescription
propsOmit<IYoutubeLiteBlock, "component">The Block props

Returns​

Element

Defined in​

packages/core/src/react/blocks/YoutubeLiteBlock.tsx:41

getAlignStyle​

▸ getAlignStyle(domNode): "none" | "left" | "center" | "right" | "wide" | "full"

Parameters​

NameType
domNodeElement

Returns​

"none" | "left" | "center" | "right" | "wide" | "full"

Defined in​

packages/core/src/react/blocks/utils.ts:5

getBlockStyle​

▸ getBlockStyle(domNode): string

Returns the block style (is-style-{block-style})

Parameters​

NameTypeDescription
domNodeElementDomNode

Returns​

string

string with block style

Defined in​

packages/core/src/react/blocks/utils.ts:39

getColorStyles​

▸ getColorStyles(domNode): Colors

Infer GB color styles from classnames

Parameters​

NameTypeDescription
domNodeElementDomNode

Returns​

Colors

ColorBlockProps object

Defined in​

packages/core/src/react/blocks/utils.ts:62

getInlineStyles​

▸ getInlineStyles(domNode): false | Record<string, string>

Converts inline styles to a stylesObject for use in react components

Parameters​

NameTypeDescription
domNodeElementDomNode

Returns​

false | Record<string, string>

Defined in​

packages/core/src/react/blocks/utils.ts:120

getTypographyStyles​

▸ getTypographyStyles(domNode): Object

Returns the typography styles of a block

Parameters​

NameTypeDescription
domNodeElementDomNode

Returns​

Object

NameType
fontSizestring
style{ fontSize: string = ''; lineHeight: string = '' }
style.fontSizestring
style.lineHeightstring

Defined in​

packages/core/src/react/blocks/utils.ts:177

getWidthStyles​

▸ getWidthStyles(domNode): undefined | string

Returns the width size of a block

Parameters​

NameTypeDescription
domNodeElementDomNode

Returns​

undefined | string

Defined in​

packages/core/src/react/blocks/utils.ts:149

parseSeo​

▸ parseSeo(seo, options?): string | Element | Element[]

Parameters​

NameType
seostring
optionsHTMLReactParserOptions

Returns​

string | Element | Element[]

Defined in​

packages/core/src/react/utils/parseSeo.ts:4

safeArraySpread​

▸ safeArraySpread(array): any[]

Parameters​

NameType
arrayany

Returns​

any[]

Defined in​

packages/core/src/react/blocks/utils.ts:220

serializeKey​

▸ serializeKey(key): string

Parameters​

NameType
keyKey

Returns​

string

Defined in​

node_modules/swr/core/dist/index.d.ts:17

useBlock​

▸ useBlock<T>(node?): Object

Returns the block name and attributes

Type parameters​

NameType
Textends IBlockAttributes

Parameters​

NameTypeDescription
node?ElementDomNode

Returns​

Object

NameType
attributesT
classNamestring
namestring

Defined in​

packages/core/src/react/blocks/hooks/useBlock.ts:38

useBlockAlign​

▸ useBlockAlign(node): Align

Returns the block align style (if available)

Parameters​

NameTypeDescription
nodeElementDomNode

Returns​

Align

Defined in​

packages/core/src/react/blocks/hooks/useBlockAlign.ts:16

useBlockAttributes​

▸ useBlockAttributes(node?): Object

useBlockAttributes hooks returns the block attributes for a given block based on what it supports

Parameters​

NameTypeDescription
node?ElementThe reference to the dom node of the block

Returns​

Object

NameType
alignAlign
blockStylestring
borderBorder
colorsColors
spacingSpacing
typographyTypography
widthundefined | string

Defined in​

packages/core/src/react/blocks/hooks/useBlockAttributes.ts:19

useBlockBorder​

▸ useBlockBorder(node): Border

Returns the block style (if available)

Parameters​

NameTypeDescription
nodeElementDomNode

Returns​

Border

Defined in​

packages/core/src/react/blocks/hooks/useBlockBorder.ts:17

useBlockColors​

▸ useBlockColors(node): Colors

Returns the block style (if available)

Parameters​

NameTypeDescription
nodeElementDomNode

Returns​

Colors

Defined in​

packages/core/src/react/blocks/hooks/useBlockColors.ts:25

useBlockSpacing​

▸ useBlockSpacing(node): Spacing

Returns the block style (if available)

Parameters​

NameTypeDescription
nodeElementDomNode

Returns​

Spacing

Defined in​

packages/core/src/react/blocks/hooks/useBlockSpacing.ts:21

useBlockStyle​

▸ useBlockStyle(node): string

Returns the block style (if available)

Parameters​

NameTypeDescription
nodeElementDomNode

Returns​

string

Defined in​

packages/core/src/react/blocks/hooks/useBlockStyle.ts:10

useBlockTypography​

▸ useBlockTypography(node): Typography

Returns the block style (if available)

Parameters​

NameTypeDescription
nodeElementDomNode

Returns​

Typography

Defined in​

packages/core/src/react/blocks/hooks/useBlockTypography.ts:25

useBlockWidth​

▸ useBlockWidth(node): undefined | string

Returns the block style (if available)

Parameters​

NameTypeDescription
nodeElementDomNode

Returns​

undefined | string

Defined in​

packages/core/src/react/blocks/hooks/useBlockWidth.ts:16

useFetchAuthorArchive​

▸ useFetchAuthorArchive<T, P>(params?, options?, path?): usePostsResponse<T>

The useFetchAuthorArchive hook

See useAuthorArchive

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters​

NameTypeDefault valueDescription
params{} | PostEntity{}The list of params to pass to the fetch strategy. It overrides the ones in the URL.
optionsFetchHookOptions<FetchResponse<T[]>>{}The options to pass to the swr hook.
pathstring''The path of the url to get url params from.

Returns​

usePostsResponse<T>

Defined in​

packages/core/src/react/hooks/useFetchAuthorArchive.ts:22

useFetchPost​

▸ useFetchPost<T, P>(params?, options?, path?): usePostResponse<T>

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostParams = PostParams

Parameters​

NameTypeDefault value
params{} | P{}
optionsFetchHookOptions<FetchResponse<T>>{}
pathstring''

Returns​

usePostResponse<T>

Defined in​

packages/core/src/react/hooks/useFetchPost.ts:30

useFetchPostOrPosts​

▸ useFetchPostOrPosts<T, P>(params?, options?, path?): usePostOrPostResponse<T>

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostOrPostsParams = PostOrPostsParams

Parameters​

NameTypeDefault value
paramsPartial<P>{}
optionsFetchHookOptions<FetchResponse<PostOrPostsFetchStrategyResult<T>>>{}
pathstring''

Returns​

usePostOrPostResponse<T>

Defined in​

packages/core/src/react/hooks/useFetchPostOrPosts.ts:32

useSWR​

▸ useSWR<Data, Error, SWRKey>(key): SWRResponse<Data, Error, any>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
  const { data, error } = useSWR('/api/user', fetcher)
  if (error) return <div>failed to load</div>
  if (!data) return <div>loading...</div>
  return <div>hello {data.name}!</div>
}

Type parameters​

NameType
Dataany
Errorany
SWRKeyextends Key = StrictKey

Parameters​

NameType
keySWRKey

Returns​

SWRResponse<Data, Error, any>

Defined in​

node_modules/swr/_internal/dist/index.d.ts:200

▸ useSWR<Data, Error, SWRKey>(key, fetcher): SWRResponse<Data, Error, any>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
  const { data, error } = useSWR('/api/user', fetcher)
  if (error) return <div>failed to load</div>
  if (!data) return <div>loading...</div>
  return <div>hello {data.name}!</div>
}

Type parameters​

NameType
Dataany
Errorany
SWRKeyextends Key = StrictKey

Parameters​

NameType
keySWRKey
fetchernull | Fetcher<Data, SWRKey>

Returns​

SWRResponse<Data, Error, any>

Defined in​

node_modules/swr/_internal/dist/index.d.ts:201

▸ useSWR<Data, Error, SWRKey, SWROptions>(key, config): SWRResponse<Data, Error, SWROptions>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
  const { data, error } = useSWR('/api/user', fetcher)
  if (error) return <div>failed to load</div>
  if (!data) return <div>loading...</div>
  return <div>hello {data.name}!</div>
}

Type parameters​

NameType
Dataany
Errorany
SWRKeyextends Key = StrictKey
SWROptionsextends undefined | Partial<PublicConfiguration<Data, Error, Fetcher<Data, SWRKey>>> = undefined | Partial<PublicConfiguration<Data, Error, Fetcher<Data, SWRKey>>>

Parameters​

NameType
keySWRKey
configSWROptions

Returns​

SWRResponse<Data, Error, SWROptions>

Defined in​

node_modules/swr/_internal/dist/index.d.ts:202

▸ useSWR<Data, Error, SWRKey, SWROptions>(key, fetcher, config): SWRResponse<Data, Error, SWROptions>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
  const { data, error } = useSWR('/api/user', fetcher)
  if (error) return <div>failed to load</div>
  if (!data) return <div>loading...</div>
  return <div>hello {data.name}!</div>
}

Type parameters​

NameType
Dataany
Errorany
SWRKeyextends Key = StrictKey
SWROptionsextends undefined | Partial<PublicConfiguration<Data, Error, Fetcher<Data, SWRKey>>> = undefined | Partial<PublicConfiguration<Data, Error, Fetcher<Data, SWRKey>>>

Parameters​

NameType
keySWRKey
fetchernull | Fetcher<Data, SWRKey>
configSWROptions

Returns​

SWRResponse<Data, Error, SWROptions>

Defined in​

node_modules/swr/_internal/dist/index.d.ts:203

▸ useSWR<Data, Error>(key): SWRResponse<Data, Error, any>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
  const { data, error } = useSWR('/api/user', fetcher)
  if (error) return <div>failed to load</div>
  if (!data) return <div>loading...</div>
  return <div>hello {data.name}!</div>
}

Type parameters​

NameType
Dataany
Errorany

Parameters​

NameType
keyKey

Returns​

SWRResponse<Data, Error, any>

Defined in​

node_modules/swr/_internal/dist/index.d.ts:204

▸ useSWR<Data, Error>(key, fetcher): SWRResponse<Data, Error, any>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
  const { data, error } = useSWR('/api/user', fetcher)
  if (error) return <div>failed to load</div>
  if (!data) return <div>loading...</div>
  return <div>hello {data.name}!</div>
}

Type parameters​

NameType
Dataany
Errorany

Parameters​

NameType
keyKey
fetchernull | BareFetcher<Data>

Returns​

SWRResponse<Data, Error, any>

Defined in​

node_modules/swr/_internal/dist/index.d.ts:205

▸ useSWR<Data, Error, SWROptions>(key, config): SWRResponse<Data, Error, SWROptions>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
  const { data, error } = useSWR('/api/user', fetcher)
  if (error) return <div>failed to load</div>
  if (!data) return <div>loading...</div>
  return <div>hello {data.name}!</div>
}

Type parameters​

NameType
Dataany
Errorany
SWROptionsextends undefined | Partial<PublicConfiguration<Data, Error, BareFetcher<Data>>> = undefined | Partial<PublicConfiguration<Data, Error, BareFetcher<Data>>>

Parameters​

NameType
keyKey
configSWROptions

Returns​

SWRResponse<Data, Error, SWROptions>

Defined in​

node_modules/swr/_internal/dist/index.d.ts:206

▸ useSWR<Data, Error, SWROptions>(key, fetcher, config): SWRResponse<Data, Error, SWROptions>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
  const { data, error } = useSWR('/api/user', fetcher)
  if (error) return <div>failed to load</div>
  if (!data) return <div>loading...</div>
  return <div>hello {data.name}!</div>
}

Type parameters​

NameType
Dataany
Errorany
SWROptionsextends undefined | Partial<PublicConfiguration<Data, Error, BareFetcher<Data>>> = undefined | Partial<PublicConfiguration<Data, Error, BareFetcher<Data>>>

Parameters​

NameType
keyKey
fetchernull | BareFetcher<Data>
configSWROptions

Returns​

SWRResponse<Data, Error, SWROptions>

Defined in​

node_modules/swr/_internal/dist/index.d.ts:207

useSWRConfig​

▸ useSWRConfig(): FullConfiguration<any, any, BareFetcher<unknown>>

Returns​

FullConfiguration<any, any, BareFetcher<unknown>>

Defined in​

node_modules/swr/_internal/dist/index.d.ts:336

useSettings​

▸ useSettings(): Partial<SettingsContextProps>

Returns​

Partial<SettingsContextProps>

Defined in​

packages/core/src/react/provider/useSettings.ts:4

useThemeSetting​

▸ useThemeSetting(path, blockName?, defaultValue?, fallbackToGlobalSetting?): any

Returns a single theme setting normalized

Parameters​

NameTypeDefault valueDescription
pathstringundefinedThe path to the setting
blockNamenull | string''The block name
defaultValueany''the default value to return
fallbackToGlobalSettingbooleantrueWhether it should fallback to global setting if blockName is passed but setting does not exist

Returns​

any

Defined in​

packages/core/src/react/provider/useThemeSetting.ts:22

useThemeSettings​

▸ useThemeSettings(): undefined | SettingsProperties & { blocks?: { core/archives?: SettingsPropertiesComplete ; core/audio?: SettingsPropertiesComplete ; core/block?: SettingsPropertiesComplete ; core/button?: SettingsPropertiesComplete ; core/buttons?: SettingsPropertiesComplete ; core/calendar?: SettingsPropertiesComplete ; core/categories?: SettingsPropertiesComplete ; core/code?: SettingsPropertiesComplete ; core/column?: SettingsPropertiesComplete ; core/columns?: SettingsPropertiesComplete ; core/comment-author-avatar?: SettingsPropertiesComplete ; core/comment-author-name?: SettingsPropertiesComplete ; core/comment-content?: SettingsPropertiesComplete ; core/comment-date?: SettingsPropertiesComplete ; core/comment-edit-link?: SettingsPropertiesComplete ; core/comment-reply-link?: SettingsPropertiesComplete ; core/comment-template?: SettingsPropertiesComplete ; core/comments-query-loop?: SettingsPropertiesComplete ; core/cover?: SettingsPropertiesComplete ; core/embed?: SettingsPropertiesComplete ; core/file?: SettingsPropertiesComplete ; core/freeform?: SettingsPropertiesComplete ; core/gallery?: SettingsPropertiesComplete ; core/group?: SettingsPropertiesComplete ; core/heading?: SettingsPropertiesComplete ; core/home-link?: SettingsPropertiesComplete ; core/html?: SettingsPropertiesComplete ; core/image?: SettingsPropertiesComplete ; core/latest-comments?: SettingsPropertiesComplete ; core/latest-posts?: SettingsPropertiesComplete ; core/legacy-widget?: SettingsPropertiesComplete ; core/list?: SettingsPropertiesComplete ; core/loginout?: SettingsPropertiesComplete ; core/media-text?: SettingsPropertiesComplete ; core/missing?: SettingsPropertiesComplete ; core/more?: SettingsPropertiesComplete ; core/navigation?: SettingsPropertiesComplete ; core/navigation-link?: SettingsPropertiesComplete ; core/nextpage?: SettingsPropertiesComplete ; core/page-list?: SettingsPropertiesComplete ; core/paragraph?: SettingsPropertiesComplete ; core/post-author?: SettingsPropertiesComplete ; core/post-comments?: SettingsPropertiesComplete ; core/post-comments-count?: SettingsPropertiesComplete ; core/post-comments-form?: SettingsPropertiesComplete ; core/post-comments-link?: SettingsPropertiesComplete ; core/post-content?: SettingsPropertiesComplete ; core/post-date?: SettingsPropertiesComplete ; core/post-excerpt?: SettingsPropertiesComplete ; core/post-featured-image?: SettingsPropertiesComplete ; core/post-navigation-link?: SettingsPropertiesComplete ; core/post-template?: SettingsPropertiesComplete ; core/post-terms?: SettingsPropertiesComplete ; core/post-title?: SettingsPropertiesComplete ; core/preformatted?: SettingsPropertiesComplete ; core/pullquote?: SettingsPropertiesComplete ; core/query?: SettingsPropertiesComplete ; core/query-pagination?: SettingsPropertiesComplete ; core/query-pagination-next?: SettingsPropertiesComplete ; core/query-pagination-numbers?: SettingsPropertiesComplete ; core/query-pagination-previous?: SettingsPropertiesComplete ; core/query-title?: SettingsPropertiesComplete ; core/quote?: SettingsPropertiesComplete ; core/rss?: SettingsPropertiesComplete ; core/search?: SettingsPropertiesComplete ; core/separator?: SettingsPropertiesComplete ; core/shortcode?: SettingsPropertiesComplete ; core/site-logo?: SettingsPropertiesComplete ; core/site-tagline?: SettingsPropertiesComplete ; core/site-title?: SettingsPropertiesComplete ; core/social-link?: SettingsPropertiesComplete ; core/social-links?: SettingsPropertiesComplete ; core/spacer?: SettingsPropertiesComplete ; core/table?: SettingsPropertiesComplete ; core/table-of-contents?: SettingsPropertiesComplete ; core/tag-cloud?: SettingsPropertiesComplete ; core/template-part?: SettingsPropertiesComplete ; core/term-description?: SettingsPropertiesComplete ; core/text-columns?: SettingsPropertiesComplete ; core/verse?: SettingsPropertiesComplete ; core/video?: SettingsPropertiesComplete ; core/widget-area?: SettingsPropertiesComplete ; core/widget-group?: SettingsPropertiesComplete } ; border?: { color?: boolean ; radius?: boolean ; style?: boolean ; width?: boolean } ; color?: { background?: boolean ; custom?: boolean ; customDuotone?: boolean ; customGradient?: boolean ; defaultGradients?: boolean ; defaultPalette?: boolean ; duotone?: SettingsDuotone ; gradients?: SettingsGradient ; link?: boolean ; palette?: SettingsColorPalette ; text?: boolean } ; custom?: { [k: string]: string | number | SettingsCustomAdditionalProperties; } ; layout?: { contentSize?: string ; wideSize?: string } ; spacing?: { blockGap?: null | boolean ; margin?: boolean ; padding?: boolean ; units?: string[] } ; typography?: { customFontSize?: boolean ; dropCap?: boolean ; fontFamilies?: { fontFamily?: string ; name?: string ; slug?: string }[] ; fontSizes?: { name?: string ; size?: string ; slug?: string }[] ; fontStyle?: boolean ; fontWeight?: boolean ; letterSpacing?: boolean ; lineHeight?: boolean ; textDecoration?: boolean ; textTransform?: boolean } }

Returns the raw theme.json settings definitions

Returns​

undefined | SettingsProperties & { blocks?: { core/archives?: SettingsPropertiesComplete ; core/audio?: SettingsPropertiesComplete ; core/block?: SettingsPropertiesComplete ; core/button?: SettingsPropertiesComplete ; core/buttons?: SettingsPropertiesComplete ; core/calendar?: SettingsPropertiesComplete ; core/categories?: SettingsPropertiesComplete ; core/code?: SettingsPropertiesComplete ; core/column?: SettingsPropertiesComplete ; core/columns?: SettingsPropertiesComplete ; core/comment-author-avatar?: SettingsPropertiesComplete ; core/comment-author-name?: SettingsPropertiesComplete ; core/comment-content?: SettingsPropertiesComplete ; core/comment-date?: SettingsPropertiesComplete ; core/comment-edit-link?: SettingsPropertiesComplete ; core/comment-reply-link?: SettingsPropertiesComplete ; core/comment-template?: SettingsPropertiesComplete ; core/comments-query-loop?: SettingsPropertiesComplete ; core/cover?: SettingsPropertiesComplete ; core/embed?: SettingsPropertiesComplete ; core/file?: SettingsPropertiesComplete ; core/freeform?: SettingsPropertiesComplete ; core/gallery?: SettingsPropertiesComplete ; core/group?: SettingsPropertiesComplete ; core/heading?: SettingsPropertiesComplete ; core/home-link?: SettingsPropertiesComplete ; core/html?: SettingsPropertiesComplete ; core/image?: SettingsPropertiesComplete ; core/latest-comments?: SettingsPropertiesComplete ; core/latest-posts?: SettingsPropertiesComplete ; core/legacy-widget?: SettingsPropertiesComplete ; core/list?: SettingsPropertiesComplete ; core/loginout?: SettingsPropertiesComplete ; core/media-text?: SettingsPropertiesComplete ; core/missing?: SettingsPropertiesComplete ; core/more?: SettingsPropertiesComplete ; core/navigation?: SettingsPropertiesComplete ; core/navigation-link?: SettingsPropertiesComplete ; core/nextpage?: SettingsPropertiesComplete ; core/page-list?: SettingsPropertiesComplete ; core/paragraph?: SettingsPropertiesComplete ; core/post-author?: SettingsPropertiesComplete ; core/post-comments?: SettingsPropertiesComplete ; core/post-comments-count?: SettingsPropertiesComplete ; core/post-comments-form?: SettingsPropertiesComplete ; core/post-comments-link?: SettingsPropertiesComplete ; core/post-content?: SettingsPropertiesComplete ; core/post-date?: SettingsPropertiesComplete ; core/post-excerpt?: SettingsPropertiesComplete ; core/post-featured-image?: SettingsPropertiesComplete ; core/post-navigation-link?: SettingsPropertiesComplete ; core/post-template?: SettingsPropertiesComplete ; core/post-terms?: SettingsPropertiesComplete ; core/post-title?: SettingsPropertiesComplete ; core/preformatted?: SettingsPropertiesComplete ; core/pullquote?: SettingsPropertiesComplete ; core/query?: SettingsPropertiesComplete ; core/query-pagination?: SettingsPropertiesComplete ; core/query-pagination-next?: SettingsPropertiesComplete ; core/query-pagination-numbers?: SettingsPropertiesComplete ; core/query-pagination-previous?: SettingsPropertiesComplete ; core/query-title?: SettingsPropertiesComplete ; core/quote?: SettingsPropertiesComplete ; core/rss?: SettingsPropertiesComplete ; core/search?: SettingsPropertiesComplete ; core/separator?: SettingsPropertiesComplete ; core/shortcode?: SettingsPropertiesComplete ; core/site-logo?: SettingsPropertiesComplete ; core/site-tagline?: SettingsPropertiesComplete ; core/site-title?: SettingsPropertiesComplete ; core/social-link?: SettingsPropertiesComplete ; core/social-links?: SettingsPropertiesComplete ; core/spacer?: SettingsPropertiesComplete ; core/table?: SettingsPropertiesComplete ; core/table-of-contents?: SettingsPropertiesComplete ; core/tag-cloud?: SettingsPropertiesComplete ; core/template-part?: SettingsPropertiesComplete ; core/term-description?: SettingsPropertiesComplete ; core/text-columns?: SettingsPropertiesComplete ; core/verse?: SettingsPropertiesComplete ; core/video?: SettingsPropertiesComplete ; core/widget-area?: SettingsPropertiesComplete ; core/widget-group?: SettingsPropertiesComplete } ; border?: { color?: boolean ; radius?: boolean ; style?: boolean ; width?: boolean } ; color?: { background?: boolean ; custom?: boolean ; customDuotone?: boolean ; customGradient?: boolean ; defaultGradients?: boolean ; defaultPalette?: boolean ; duotone?: SettingsDuotone ; gradients?: SettingsGradient ; link?: boolean ; palette?: SettingsColorPalette ; text?: boolean } ; custom?: { [k: string]: string | number | SettingsCustomAdditionalProperties; } ; layout?: { contentSize?: string ; wideSize?: string } ; spacing?: { blockGap?: null | boolean ; margin?: boolean ; padding?: boolean ; units?: string[] } ; typography?: { customFontSize?: boolean ; dropCap?: boolean ; fontFamilies?: { fontFamily?: string ; name?: string ; slug?: string }[] ; fontSizes?: { name?: string ; size?: string ; slug?: string }[] ; fontStyle?: boolean ; fontWeight?: boolean ; letterSpacing?: boolean ; lineHeight?: boolean ; textDecoration?: boolean ; textTransform?: boolean } }

Defined in​

packages/core/src/react/provider/useThemeSettings.ts:9

useThemeStyles​

▸ useThemeStyles(): undefined | StylesProperties & { blocks?: { core/archives?: StylesPropertiesAndElementsComplete ; core/audio?: StylesPropertiesAndElementsComplete ; core/block?: StylesPropertiesAndElementsComplete ; core/button?: StylesPropertiesAndElementsComplete ; core/buttons?: StylesPropertiesAndElementsComplete ; core/calendar?: StylesPropertiesAndElementsComplete ; core/categories?: StylesPropertiesAndElementsComplete ; core/code?: StylesPropertiesAndElementsComplete ; core/column?: StylesPropertiesAndElementsComplete ; core/columns?: StylesPropertiesAndElementsComplete ; core/comment-author-avatar?: StylesPropertiesAndElementsComplete ; core/comment-author-name?: StylesPropertiesAndElementsComplete ; core/comment-content?: StylesPropertiesAndElementsComplete ; core/comment-date?: StylesPropertiesAndElementsComplete ; core/comment-edit-link?: StylesPropertiesAndElementsComplete ; core/comment-reply-link?: StylesPropertiesAndElementsComplete ; core/comment-template?: StylesPropertiesAndElementsComplete ; core/comments-query-loop?: StylesPropertiesAndElementsComplete ; core/cover?: StylesPropertiesAndElementsComplete ; core/embed?: StylesPropertiesAndElementsComplete ; core/file?: StylesPropertiesAndElementsComplete ; core/freeform?: StylesPropertiesAndElementsComplete ; core/gallery?: StylesPropertiesAndElementsComplete ; core/group?: StylesPropertiesAndElementsComplete ; core/heading?: StylesPropertiesAndElementsComplete ; core/home-link?: StylesPropertiesAndElementsComplete ; core/html?: StylesPropertiesAndElementsComplete ; core/image?: StylesPropertiesAndElementsComplete ; core/latest-comments?: StylesPropertiesAndElementsComplete ; core/latest-posts?: StylesPropertiesAndElementsComplete ; core/legacy-widget?: StylesPropertiesAndElementsComplete ; core/list?: StylesPropertiesAndElementsComplete ; core/loginout?: StylesPropertiesAndElementsComplete ; core/media-text?: StylesPropertiesAndElementsComplete ; core/missing?: StylesPropertiesAndElementsComplete ; core/more?: StylesPropertiesAndElementsComplete ; core/navigation?: StylesPropertiesAndElementsComplete ; core/navigation-link?: StylesPropertiesAndElementsComplete ; core/nextpage?: StylesPropertiesAndElementsComplete ; core/page-list?: StylesPropertiesAndElementsComplete ; core/paragraph?: StylesPropertiesAndElementsComplete ; core/post-author?: StylesPropertiesAndElementsComplete ; core/post-comments?: StylesPropertiesAndElementsComplete ; core/post-comments-count?: StylesPropertiesAndElementsComplete ; core/post-comments-form?: StylesPropertiesAndElementsComplete ; core/post-comments-link?: StylesPropertiesAndElementsComplete ; core/post-content?: StylesPropertiesAndElementsComplete ; core/post-date?: StylesPropertiesAndElementsComplete ; core/post-excerpt?: StylesPropertiesAndElementsComplete ; core/post-featured-image?: StylesPropertiesAndElementsComplete ; core/post-navigation-link?: StylesPropertiesAndElementsComplete ; core/post-template?: StylesPropertiesAndElementsComplete ; core/post-terms?: StylesPropertiesAndElementsComplete ; core/post-title?: StylesPropertiesAndElementsComplete ; core/preformatted?: StylesPropertiesAndElementsComplete ; core/pullquote?: StylesPropertiesAndElementsComplete ; core/query?: StylesPropertiesAndElementsComplete ; core/query-pagination?: StylesPropertiesAndElementsComplete ; core/query-pagination-next?: StylesPropertiesAndElementsComplete ; core/query-pagination-numbers?: StylesPropertiesAndElementsComplete ; core/query-pagination-previous?: StylesPropertiesAndElementsComplete ; core/query-title?: StylesPropertiesAndElementsComplete ; core/quote?: StylesPropertiesAndElementsComplete ; core/rss?: StylesPropertiesAndElementsComplete ; core/search?: StylesPropertiesAndElementsComplete ; core/separator?: StylesPropertiesAndElementsComplete ; core/shortcode?: StylesPropertiesAndElementsComplete ; core/site-logo?: StylesPropertiesAndElementsComplete ; core/site-tagline?: StylesPropertiesAndElementsComplete ; core/site-title?: StylesPropertiesAndElementsComplete ; core/social-link?: StylesPropertiesAndElementsComplete ; core/social-links?: StylesPropertiesAndElementsComplete ; core/spacer?: StylesPropertiesAndElementsComplete ; core/table?: StylesPropertiesAndElementsComplete ; core/table-of-contents?: StylesPropertiesAndElementsComplete ; core/tag-cloud?: StylesPropertiesAndElementsComplete ; core/template-part?: StylesPropertiesAndElementsComplete ; core/term-description?: StylesPropertiesAndElementsComplete ; core/text-columns?: StylesPropertiesAndElementsComplete ; core/verse?: StylesPropertiesAndElementsComplete ; core/video?: StylesPropertiesAndElementsComplete ; core/widget-area?: StylesPropertiesAndElementsComplete ; core/widget-group?: StylesPropertiesAndElementsComplete } ; border?: unknown ; color?: unknown ; elements?: { h1?: StylesPropertiesComplete ; h2?: StylesPropertiesComplete ; h3?: StylesPropertiesComplete ; h4?: StylesPropertiesComplete ; h5?: StylesPropertiesComplete ; h6?: StylesPropertiesComplete ; link?: StylesPropertiesComplete } ; spacing?: unknown ; typography?: unknown }

Returns the theme.json styles definitions

Returns​

undefined | StylesProperties & { blocks?: { core/archives?: StylesPropertiesAndElementsComplete ; core/audio?: StylesPropertiesAndElementsComplete ; core/block?: StylesPropertiesAndElementsComplete ; core/button?: StylesPropertiesAndElementsComplete ; core/buttons?: StylesPropertiesAndElementsComplete ; core/calendar?: StylesPropertiesAndElementsComplete ; core/categories?: StylesPropertiesAndElementsComplete ; core/code?: StylesPropertiesAndElementsComplete ; core/column?: StylesPropertiesAndElementsComplete ; core/columns?: StylesPropertiesAndElementsComplete ; core/comment-author-avatar?: StylesPropertiesAndElementsComplete ; core/comment-author-name?: StylesPropertiesAndElementsComplete ; core/comment-content?: StylesPropertiesAndElementsComplete ; core/comment-date?: StylesPropertiesAndElementsComplete ; core/comment-edit-link?: StylesPropertiesAndElementsComplete ; core/comment-reply-link?: StylesPropertiesAndElementsComplete ; core/comment-template?: StylesPropertiesAndElementsComplete ; core/comments-query-loop?: StylesPropertiesAndElementsComplete ; core/cover?: StylesPropertiesAndElementsComplete ; core/embed?: StylesPropertiesAndElementsComplete ; core/file?: StylesPropertiesAndElementsComplete ; core/freeform?: StylesPropertiesAndElementsComplete ; core/gallery?: StylesPropertiesAndElementsComplete ; core/group?: StylesPropertiesAndElementsComplete ; core/heading?: StylesPropertiesAndElementsComplete ; core/home-link?: StylesPropertiesAndElementsComplete ; core/html?: StylesPropertiesAndElementsComplete ; core/image?: StylesPropertiesAndElementsComplete ; core/latest-comments?: StylesPropertiesAndElementsComplete ; core/latest-posts?: StylesPropertiesAndElementsComplete ; core/legacy-widget?: StylesPropertiesAndElementsComplete ; core/list?: StylesPropertiesAndElementsComplete ; core/loginout?: StylesPropertiesAndElementsComplete ; core/media-text?: StylesPropertiesAndElementsComplete ; core/missing?: StylesPropertiesAndElementsComplete ; core/more?: StylesPropertiesAndElementsComplete ; core/navigation?: StylesPropertiesAndElementsComplete ; core/navigation-link?: StylesPropertiesAndElementsComplete ; core/nextpage?: StylesPropertiesAndElementsComplete ; core/page-list?: StylesPropertiesAndElementsComplete ; core/paragraph?: StylesPropertiesAndElementsComplete ; core/post-author?: StylesPropertiesAndElementsComplete ; core/post-comments?: StylesPropertiesAndElementsComplete ; core/post-comments-count?: StylesPropertiesAndElementsComplete ; core/post-comments-form?: StylesPropertiesAndElementsComplete ; core/post-comments-link?: StylesPropertiesAndElementsComplete ; core/post-content?: StylesPropertiesAndElementsComplete ; core/post-date?: StylesPropertiesAndElementsComplete ; core/post-excerpt?: StylesPropertiesAndElementsComplete ; core/post-featured-image?: StylesPropertiesAndElementsComplete ; core/post-navigation-link?: StylesPropertiesAndElementsComplete ; core/post-template?: StylesPropertiesAndElementsComplete ; core/post-terms?: StylesPropertiesAndElementsComplete ; core/post-title?: StylesPropertiesAndElementsComplete ; core/preformatted?: StylesPropertiesAndElementsComplete ; core/pullquote?: StylesPropertiesAndElementsComplete ; core/query?: StylesPropertiesAndElementsComplete ; core/query-pagination?: StylesPropertiesAndElementsComplete ; core/query-pagination-next?: StylesPropertiesAndElementsComplete ; core/query-pagination-numbers?: StylesPropertiesAndElementsComplete ; core/query-pagination-previous?: StylesPropertiesAndElementsComplete ; core/query-title?: StylesPropertiesAndElementsComplete ; core/quote?: StylesPropertiesAndElementsComplete ; core/rss?: StylesPropertiesAndElementsComplete ; core/search?: StylesPropertiesAndElementsComplete ; core/separator?: StylesPropertiesAndElementsComplete ; core/shortcode?: StylesPropertiesAndElementsComplete ; core/site-logo?: StylesPropertiesAndElementsComplete ; core/site-tagline?: StylesPropertiesAndElementsComplete ; core/site-title?: StylesPropertiesAndElementsComplete ; core/social-link?: StylesPropertiesAndElementsComplete ; core/social-links?: StylesPropertiesAndElementsComplete ; core/spacer?: StylesPropertiesAndElementsComplete ; core/table?: StylesPropertiesAndElementsComplete ; core/table-of-contents?: StylesPropertiesAndElementsComplete ; core/tag-cloud?: StylesPropertiesAndElementsComplete ; core/template-part?: StylesPropertiesAndElementsComplete ; core/term-description?: StylesPropertiesAndElementsComplete ; core/text-columns?: StylesPropertiesAndElementsComplete ; core/verse?: StylesPropertiesAndElementsComplete ; core/video?: StylesPropertiesAndElementsComplete ; core/widget-area?: StylesPropertiesAndElementsComplete ; core/widget-group?: StylesPropertiesAndElementsComplete } ; border?: unknown ; color?: unknown ; elements?: { h1?: StylesPropertiesComplete ; h2?: StylesPropertiesComplete ; h3?: StylesPropertiesComplete ; h4?: StylesPropertiesComplete ; h5?: StylesPropertiesComplete ; h6?: StylesPropertiesComplete ; link?: StylesPropertiesComplete } ; spacing?: unknown ; typography?: unknown }

Defined in​

packages/core/src/react/provider/useThemeStyles.ts:9

React Components​

BlocksRenderer​

▸ BlocksRenderer(props): Element

The BlocksRenderer components provides an easy way to convert HTML markup into corresponding +the actual data fetching logic

Type parameters​

NameType
EE
Paramsextends EndpointParams
RE

Parameters​

NameTypeDefault valueDescription
params{} | ParamsundefinedThe list of params to pass to the fetch strategy. It overrides the ones in the URL.
fetchStrategyAbstractFetchStrategy<E, Params, R>undefinedThe fetch strategy.
optionsFetchHookOptions<FetchResponse<R>>{}The options to pass to the swr hook.
pathstring''The path of the url to get url params from.

Returns​

Object

NameTypeDescription
dataundefined | FetchResponse<R>The returned data of the fetcher function.
erroranyThe error object thrown by the fetcher function.
isLoadingboolean-
isMainQueryboolean-
isValidatingboolean-
mutateKeyedMutator<FetchResponse<R>>-
paramsPartial<Params>-

Defined in​

packages/core/src/react/hooks/useFetch.ts:30

useFetchAppSettings​

▸ useFetchAppSettings<T, P>(params?, options?): useAppSettingsResponse<T>

The useAppSettings hook

See useAppSettings

Type parameters​

NameType
Textends AppEntity = AppEntity
Pextends EndpointParams = EndpointParams

Parameters​

NameTypeDescription
params{} | PThe list of params to pass to the fetch strategy. It overrides the ones in the URL.
optionsFetchHookOptions<FetchResponse<T>>The options to pass to the swr hook.

Returns​

useAppSettingsResponse<T>

Defined in​

packages/core/src/react/hooks/useFetchAppSettings.ts:23

useFetchMenu​

▸ useFetchMenu(menuLocation, options?): useMenuResponse

The useFetchMenu hooks. Returns a Menu object.

Parameters​

NameTypeDescription
menuLocationstringThe slug of the menu location you want to fetch
optionsFetchHookOptions<FetchResponse<AppEntity>>SWR configuration options

Returns​

useMenuResponse

Defined in​

packages/core/src/react/hooks/useFetchMenu.ts:50

useFetchPosts​

▸ useFetchPosts<T, P>(params?, options?, path?, fetcher?): usePostsResponse<T>

The useFetchPosts hook. Returns a collection of post entities

See usePosts for usage instructions.

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters​

NameTypeDefault valueDescription
params{} | P{}The list of params to pass to the fetch strategy. It overrides the ones in the URL.
optionsFetchHookOptions<FetchResponse<T[]>>{}The options to pass to the swr hook.
pathstring''The path of the url to get url params from.
fetcherundefined | PostsArchiveFetchStrategy<T, P>undefinedThe fetch strategy to use. If none is passed, the default one is used

Returns​

usePostsResponse<T>

Defined in​

packages/core/src/react/hooks/useFetchPosts.ts:81

useFetchSearch​

▸ useFetchSearch<T, P>(params?, options?, path?): useSearchResponse<T>

The useFetchSearch hook. Returns a collection of post entities

See useSearch for usage instructions.

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters​

NameTypeDefault valueDescription
params{} | P{}The list of params to pass to the fetch strategy. It overrides the ones in the URL.
optionsFetchHookOptions<FetchResponse<T[]>>{}The options to pass to the swr hook.
pathstring''The path of the url to get url params from.

Returns​

useSearchResponse<T>

Defined in​

packages/core/src/react/hooks/useFetchSearch.ts:34

useFetchSearchNative​

▸ useFetchSearchNative<T, P>(params?, options?, path?): useSearchNativeResponse<T>

The useFetchSearchNative hook. Returns a collection of search entities retrieved through the WP native search endpoint

See useSearchNative for usage instructions.

Type parameters​

NameType
Textends PostSearchEntity | TermSearchEntity = PostSearchEntity | TermSearchEntity
Pextends SearchParams = SearchParams

Parameters​

NameTypeDefault valueDescription
params{} | P{}The list of params to pass to the fetch strategy. It overrides the ones in the URL.
optionsFetchHookOptions<FetchResponse<T[]>>{}The options to pass to the swr hook.
pathstring''The path of the url to get url params from.

Returns​

useSearchNativeResponse<T>

Defined in​

packages/core/src/react/hooks/useFetchSearchNative.ts:37

useFetchTerms​

▸ useFetchTerms<T, P>(params, options?, path?): useTermsResponse<T>

The useFetchTerms hook. Returns a collection of term entities

See useTerms for usage instructions.

Type parameters​

NameType
Textends TermEntity = TermEntity
Pextends TaxonomyArchiveParams = TaxonomyArchiveParams

Parameters​

NameTypeDefault valueDescription
params{} | PundefinedThe list of params to pass to the fetch strategy. It overrides the ones in the URL.
optionsFetchHookOptions<FetchResponse<T[]>>{}The options to pass to the swr hook.
pathstring''The path of the url to get url params from.

Returns​

useTermsResponse<T>

Defined in​

packages/core/src/react/hooks/useFetchTerms.ts:31

Other​

Align​

Ƭ Align: "none" | "left" | "center" | "right" | "wide" | "full"

Defined in​

packages/core/src/react/blocks/types.ts:15

Border​

Ƭ Border: Object

Type declaration​

NameType
radius?string
style?string
width?string

Defined in​

packages/core/src/react/blocks/types.ts:65

DataFetchingProviderProps​

Ƭ DataFetchingProviderProps: Object

Type declaration​

NameTypeDescription
dataSWRConfiguration["fallback"]-
swrConfigSWRConfigurationPass any configuration to the SWR library. Globally. These settings can be overridden at the hook level.

Defined in​

packages/core/src/react/provider/DataFetchingProvider.tsx:6

ItemWrapper​

Ƭ ItemWrapper: (props: ItemWrapperProps) => JSX.Element

Type declaration​

▸ (props): JSX.Element

Parameters​
NameType
propsItemWrapperProps
Returns​

JSX.Element

Defined in​

packages/core/src/react/components/Menu.tsx:15

ItemWrapperProps​

Ƭ ItemWrapperProps: PropsWithChildren<{ className: string ; depth: number ; item: MenuItemEntity }>

Defined in​

packages/core/src/react/components/Menu.tsx:10

Ƭ LinkWrapper: (props: LinkWrapperProps) => JSX.Element

Type declaration​

▸ (props): JSX.Element

Parameters​
NameType
propsLinkWrapperProps
Returns​

JSX.Element

Defined in​

packages/core/src/react/components/Menu.tsx:27

LinkWrapperProps​

Ƭ LinkWrapperProps: PropsWithChildren<{ depth: number ; href: string }>

Defined in​

packages/core/src/react/components/Menu.tsx:23

Ƭ MenuItemsProp: Object

Type declaration​

NameType
depthnumber
itemWrapperItemWrapper
itemsMenuItemEntity[]
linkWrapperLinkWrapper
menuWrapperMenuWrapper
topLevelItemsClickableboolean

Defined in​

packages/core/src/react/components/Menu.tsx:29

Ƭ MenuWrapper: (props: MenuWrapperProps) => JSX.Element

Type declaration​

▸ (props): JSX.Element

Parameters​
NameType
propsMenuWrapperProps
Returns​

JSX.Element

Defined in​

packages/core/src/react/components/Menu.tsx:21

Ƭ MenuWrapperProps: PropsWithChildren<{ className: string ; depth: number }>

Defined in​

packages/core/src/react/components/Menu.tsx:17

PageType​

Ƭ PageType: Object

Type declaration​

NameTypeDescription
isAuthorArchivebooleanAuthor Archive
isCategoryArchivebooleanCategory Archive
isPostArchivebooleanRegular post archive
isPostTypeArchivebooleanCustom Post Type Archive
isSearchbooleanSearch route
isTagArchivebooleanTag Archive
isTaxonomyArchivebooleanCustom Taxonomy Archive
postTypestringWhich post type this archive is for
taxonomystringWhich taxonomy this archive is for

Defined in​

packages/core/src/react/hooks/useFetchPosts.ts:20

SettingsColorPalette​

Ƭ SettingsColorPalette: Object

Type declaration​

NameType
default?SettingsColorPreset[]
theme?SettingsColorPreset[]
user?SettingsColorPreset[]

Defined in​

packages/core/src/react/provider/types.ts:47

SettingsColorPreset​

Ƭ SettingsColorPreset: Object

Type declaration​

NameTypeDescription
colorstringCSS hex or rgb(a) string.
namestringName of the color preset, translatable.
slugstringKebab-case unique identifier for the color preset.

Defined in​

packages/core/src/react/provider/types.ts:32

SettingsContextProps​

Ƭ SettingsContextProps: { imageComponent?: React.FC<IImageBlock> ; linkComponent?: ReactNode } & HeadlessConfig

Defined in​

packages/core/src/react/provider/types.ts:5

SettingsDuotone​

Ƭ SettingsDuotone: Object

Type declaration​

NameType
default?SettingsDuotonePreset[]
theme?SettingsDuotonePreset[]
user?SettingsDuotonePreset[]

Defined in​

packages/core/src/react/provider/types.ts:89

SettingsDuotonePreset​

Ƭ SettingsDuotonePreset: Object

Type declaration​

NameTypeDescription
colorsstring[]List of colors from dark to light.
namestringName of the duotone preset, translatable.
slugstringKebab-case unique identifier for the duotone preset.

Defined in​

packages/core/src/react/provider/types.ts:74

SettingsGradient​

Ƭ SettingsGradient: Object

Type declaration​

NameType
default?SettingsGradientPreset[]
theme?SettingsGradientPreset[]
user?SettingsGradientPreset[]

Defined in​

packages/core/src/react/provider/types.ts:68

SettingsGradientPreset​

Ƭ SettingsGradientPreset: Object

Type declaration​

NameTypeDescription
gradientstringCSS gradient string.
namestringName of the gradient preset, translatable.
slugstringKebab-case unique identifier for the gradient preset.

Defined in​

packages/core/src/react/provider/types.ts:53

SettingsPropertiesComplete​

Ƭ SettingsPropertiesComplete: SettingsProperties & { border?: SettingsProperties["border"] ; color?: SettingsProperties["color"] ; custom?: SettingsProperties["custom"] ; layout?: SettingsProperties["layout"] ; spacing?: SettingsProperties["spacing"] ; typography?: SettingsProperties["typography"] }

Defined in​

packages/core/src/react/provider/types.ts:10

Spacing​

Ƭ Spacing: Object

Type declaration​

NameType
blockGapstring
margin{ bottom: string ; left: string ; right: string ; top: string }
margin.bottomstring
margin.leftstring
margin.rightstring
margin.topstring
padding{ bottom: string ; left: string ; right: string ; top: string }
padding.bottomstring
padding.leftstring
padding.rightstring
padding.topstring
supportsBlockGapboolean
supportsMarginboolean
supportsPaddingboolean

Defined in​

packages/core/src/react/blocks/types.ts:40

Style​

Ƭ Style: Object

Type declaration​

NameType
borderBorder
spacingSpacing
typographyTypography

Defined in​

packages/core/src/react/blocks/types.ts:17

StylesPropertiesAndElementsComplete​

Ƭ StylesPropertiesAndElementsComplete: StylesProperties & { border?: SettingsProperties["border"] ; color?: SettingsProperties["color"] ; elements?: StylesElementsPropertiesComplete ; spacing?: SettingsProperties["spacing"] ; typography?: SettingsProperties["typography"] }

Defined in​

packages/core/src/react/provider/types.ts:24

StylesPropertiesComplete​

Ƭ StylesPropertiesComplete: StylesProperties & { border?: SettingsProperties["border"] ; color?: SettingsProperties["color"] ; spacing?: SettingsProperties["spacing"] ; typography?: SettingsProperties["typography"] }

Defined in​

packages/core/src/react/provider/types.ts:18

ThemeJSON​

Ƭ ThemeJSON: Pick<WpThemeJSON, "styles" | "settings">

Defined in​

packages/core/src/react/provider/types.ts:352

SettingsContext​

• Const SettingsContext: Context<Partial<SettingsContextProps>>

Defined in​

packages/core/src/react/provider/Provider.tsx:5

ThemeSettingsContext​

• Const ThemeSettingsContext: Context<ThemeJSON>

Defined in​

packages/core/src/react/provider/ThemeSettingsProvider.tsx:4

defaultElement​

• Const defaultElement: Element

Defined in​

packages/core/src/react/blocks/hooks/useBlock.ts:8

ColumnBlock​

▸ ColumnBlock(«destructured»): Element

Parameters​

NameType
«destructured»IColumnBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/ColumnBlock.tsx:11

ColumnsBlock​

▸ ColumnsBlock(«destructured»): Element

Parameters​

NameType
«destructured»IColumnsBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/ColumnsBlocks.tsx:11

CoverBlock​

▸ CoverBlock(«destructured»): Element

Parameters​

NameType
«destructured»ICoverBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/CoverBlock.tsx:24

DataFetchingProvider​

▸ DataFetchingProvider(props, context?): null | ReactElement<any, any>

Parameters​

NameType
propsPropsWithChildren<DataFetchingProviderProps>
context?any

Returns​

null | ReactElement<any, any>

Defined in​

node_modules/@types/react/index.d.ts:542

DebugBlock​

▸ DebugBlock(«destructured»): Element

Parameters​

NameType
«destructured»Object

Returns​

Element

Defined in​

packages/core/src/react/blocks/DebugBlock.tsx:7

FileBlock​

▸ FileBlock(«destructured»): Element

Parameters​

NameType
«destructured»IFileBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/FileBlock.tsx:14

GroupBlock​

▸ GroupBlock(«destructured»): Element

Parameters​

NameType
«destructured»IGroupBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/GroupBlock.tsx:17

HeadingBlock​

▸ HeadingBlock(«destructured»): Element

Parameters​

NameType
«destructured»IHeadingBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/HeadingBlock.tsx:12

ImageBlock​

▸ ImageBlock(«destructured»): Element

Parameters​

NameType
«destructured»IImageBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/ImageBlock.tsx:19

ListBlock​

▸ ListBlock(«destructured»): Element

Parameters​

NameType
«destructured»IListBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/ListBlock.tsx:12

MediaTextBlock​

▸ MediaTextBlock(«destructured»): Element

Parameters​

NameType
«destructured»IMediaTextBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/MediaTextBlock.tsx:22

▸ Menu(«destructured»): Element

Parameters​

NameType
«destructured»MenuProps

Returns​

Element

Defined in​

packages/core/src/react/components/Menu.tsx:109

▸ MenuItems(«destructured»): Element

Parameters​

NameType
«destructured»MenuItemsProp

Returns​

Element

Defined in​

packages/core/src/react/components/Menu.tsx:54

ParagraphBlock​

▸ ParagraphBlock(«destructured»): Element

Parameters​

NameType
«destructured»IParagraphBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/ParagraphBlock.tsx:13

PreformattedBlock​

▸ PreformattedBlock(«destructured»): Element

Parameters​

NameType
«destructured»IPreformattedBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/PreformatedBlock.tsx:11

PullQuoteBlock​

▸ PullQuoteBlock(«destructured»): Element

Parameters​

NameType
«destructured»IPullQuoteBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/PullQuote.tsx:15

QuoteBlock​

▸ QuoteBlock(«destructured»): Element

Parameters​

NameType
«destructured»IQuoteBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/QuoteBlock.tsx:10

SeparatorBlock​

▸ SeparatorBlock(«destructured»): Element

Parameters​

NameType
«destructured»ISeparatorBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/SeparatorBlock.tsx:10

SettingsProvider​

▸ SettingsProvider(props, context?): null | ReactElement<any, any>

Parameters​

NameType
propsPropsWithChildren<ProviderProps>
context?any

Returns​

null | ReactElement<any, any>

Defined in​

node_modules/@types/react/index.d.ts:542

SpacerBlock​

▸ SpacerBlock(«destructured»): Element

Parameters​

NameType
«destructured»ISpacerBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/SpacerBlock.tsx:12

TableBlock​

▸ TableBlock(«destructured»): Element

Parameters​

NameType
«destructured»ITableBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/TableBlock.tsx:12

ThemeSettingsProvider​

▸ ThemeSettingsProvider(props, context?): null | ReactElement<any, any>

Parameters​

NameType
propsPropsWithChildren<ProviderProps>
context?any

Returns​

null | ReactElement<any, any>

Defined in​

node_modules/@types/react/index.d.ts:542

VerseBlock​

▸ VerseBlock(«destructured»): Element

Parameters​

NameType
«destructured»IVerseBlock

Returns​

Element

Defined in​

packages/core/src/react/blocks/VerseBlock.tsx:11

YoutubeLiteBlock​

▸ YoutubeLiteBlock(props): Element

Renders Youtube embeds with lite-youtube-embed

Parameters​

NameTypeDescription
propsOmit<IYoutubeLiteBlock, "component">The Block props

Returns​

Element

Defined in​

packages/core/src/react/blocks/YoutubeLiteBlock.tsx:41

getAlignStyle​

▸ getAlignStyle(domNode): "none" | "left" | "center" | "right" | "wide" | "full"

Parameters​

NameType
domNodeElement

Returns​

"none" | "left" | "center" | "right" | "wide" | "full"

Defined in​

packages/core/src/react/blocks/utils.ts:5

getBlockStyle​

▸ getBlockStyle(domNode): string

Returns the block style (is-style-{block-style})

Parameters​

NameTypeDescription
domNodeElementDomNode

Returns​

string

string with block style

Defined in​

packages/core/src/react/blocks/utils.ts:39

getColorStyles​

▸ getColorStyles(domNode): Colors

Infer GB color styles from classnames

Parameters​

NameTypeDescription
domNodeElementDomNode

Returns​

Colors

ColorBlockProps object

Defined in​

packages/core/src/react/blocks/utils.ts:62

getInlineStyles​

▸ getInlineStyles(domNode): false | Record<string, string>

Converts inline styles to a stylesObject for use in react components

Parameters​

NameTypeDescription
domNodeElementDomNode

Returns​

false | Record<string, string>

Defined in​

packages/core/src/react/blocks/utils.ts:120

getTypographyStyles​

▸ getTypographyStyles(domNode): Object

Returns the typography styles of a block

Parameters​

NameTypeDescription
domNodeElementDomNode

Returns​

Object

NameType
fontSizestring
style{ fontSize: string = ''; lineHeight: string = '' }
style.fontSizestring
style.lineHeightstring

Defined in​

packages/core/src/react/blocks/utils.ts:177

getWidthStyles​

▸ getWidthStyles(domNode): undefined | string

Returns the width size of a block

Parameters​

NameTypeDescription
domNodeElementDomNode

Returns​

undefined | string

Defined in​

packages/core/src/react/blocks/utils.ts:149

parseSeo​

▸ parseSeo(seo, options?): string | Element | Element[]

Parameters​

NameType
seostring
optionsHTMLReactParserOptions

Returns​

string | Element | Element[]

Defined in​

packages/core/src/react/utils/parseSeo.ts:4

safeArraySpread​

▸ safeArraySpread(array): any[]

Parameters​

NameType
arrayany

Returns​

any[]

Defined in​

packages/core/src/react/blocks/utils.ts:220

serializeKey​

▸ serializeKey(key): string

Parameters​

NameType
keyKey

Returns​

string

Defined in​

node_modules/swr/core/dist/index.d.ts:17

useBlock​

▸ useBlock<T>(node?): Object

Returns the block name and attributes

Type parameters​

NameType
Textends IBlockAttributes

Parameters​

NameTypeDescription
node?ElementDomNode

Returns​

Object

NameType
attributesT
classNamestring
namestring

Defined in​

packages/core/src/react/blocks/hooks/useBlock.ts:38

useBlockAlign​

▸ useBlockAlign(node): Align

Returns the block align style (if available)

Parameters​

NameTypeDescription
nodeElementDomNode

Returns​

Align

Defined in​

packages/core/src/react/blocks/hooks/useBlockAlign.ts:16

useBlockAttributes​

▸ useBlockAttributes(node?): Object

useBlockAttributes hooks returns the block attributes for a given block based on what it supports

Parameters​

NameTypeDescription
node?ElementThe reference to the dom node of the block

Returns​

Object

NameType
alignAlign
blockStylestring
borderBorder
colorsColors
spacingSpacing
typographyTypography
widthundefined | string

Defined in​

packages/core/src/react/blocks/hooks/useBlockAttributes.ts:19

useBlockBorder​

▸ useBlockBorder(node): Border

Returns the block style (if available)

Parameters​

NameTypeDescription
nodeElementDomNode

Returns​

Border

Defined in​

packages/core/src/react/blocks/hooks/useBlockBorder.ts:17

useBlockColors​

▸ useBlockColors(node): Colors

Returns the block style (if available)

Parameters​

NameTypeDescription
nodeElementDomNode

Returns​

Colors

Defined in​

packages/core/src/react/blocks/hooks/useBlockColors.ts:25

useBlockSpacing​

▸ useBlockSpacing(node): Spacing

Returns the block style (if available)

Parameters​

NameTypeDescription
nodeElementDomNode

Returns​

Spacing

Defined in​

packages/core/src/react/blocks/hooks/useBlockSpacing.ts:21

useBlockStyle​

▸ useBlockStyle(node): string

Returns the block style (if available)

Parameters​

NameTypeDescription
nodeElementDomNode

Returns​

string

Defined in​

packages/core/src/react/blocks/hooks/useBlockStyle.ts:10

useBlockTypography​

▸ useBlockTypography(node): Typography

Returns the block style (if available)

Parameters​

NameTypeDescription
nodeElementDomNode

Returns​

Typography

Defined in​

packages/core/src/react/blocks/hooks/useBlockTypography.ts:25

useBlockWidth​

▸ useBlockWidth(node): undefined | string

Returns the block style (if available)

Parameters​

NameTypeDescription
nodeElementDomNode

Returns​

undefined | string

Defined in​

packages/core/src/react/blocks/hooks/useBlockWidth.ts:16

useFetchAuthorArchive​

▸ useFetchAuthorArchive<T, P>(params?, options?, path?): usePostsResponse<T>

The useFetchAuthorArchive hook

See useAuthorArchive

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostsArchiveParams = PostsArchiveParams

Parameters​

NameTypeDefault valueDescription
params{} | PostEntity{}The list of params to pass to the fetch strategy. It overrides the ones in the URL.
optionsFetchHookOptions<FetchResponse<T[]>>{}The options to pass to the swr hook.
pathstring''The path of the url to get url params from.

Returns​

usePostsResponse<T>

Defined in​

packages/core/src/react/hooks/useFetchAuthorArchive.ts:22

useFetchPost​

▸ useFetchPost<T, P>(params?, options?, path?): usePostResponse<T>

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostParams = PostParams

Parameters​

NameTypeDefault value
params{} | P{}
optionsFetchHookOptions<FetchResponse<T>>{}
pathstring''

Returns​

usePostResponse<T>

Defined in​

packages/core/src/react/hooks/useFetchPost.ts:36

useFetchPostOrPosts​

▸ useFetchPostOrPosts<T, P>(params?, options?, path?): usePostOrPostResponse<T>

Type parameters​

NameType
Textends PostEntity = PostEntity
Pextends PostOrPostsParams = PostOrPostsParams

Parameters​

NameTypeDefault value
paramsPartial<P>{}
optionsFetchHookOptions<FetchResponse<PostOrPostsFetchStrategyResult<T>>>{}
pathstring''

Returns​

usePostOrPostResponse<T>

Defined in​

packages/core/src/react/hooks/useFetchPostOrPosts.ts:32

useSWR​

▸ useSWR<Data, Error, SWRKey>(key): SWRResponse<Data, Error, any>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
  const { data, error } = useSWR('/api/user', fetcher)
  if (error) return <div>failed to load</div>
  if (!data) return <div>loading...</div>
  return <div>hello {data.name}!</div>
}

Type parameters​

NameType
Dataany
Errorany
SWRKeyextends Key = StrictKey

Parameters​

NameType
keySWRKey

Returns​

SWRResponse<Data, Error, any>

Defined in​

node_modules/swr/_internal/dist/index.d.ts:200

▸ useSWR<Data, Error, SWRKey>(key, fetcher): SWRResponse<Data, Error, any>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
  const { data, error } = useSWR('/api/user', fetcher)
  if (error) return <div>failed to load</div>
  if (!data) return <div>loading...</div>
  return <div>hello {data.name}!</div>
}

Type parameters​

NameType
Dataany
Errorany
SWRKeyextends Key = StrictKey

Parameters​

NameType
keySWRKey
fetchernull | Fetcher<Data, SWRKey>

Returns​

SWRResponse<Data, Error, any>

Defined in​

node_modules/swr/_internal/dist/index.d.ts:201

▸ useSWR<Data, Error, SWRKey, SWROptions>(key, config): SWRResponse<Data, Error, SWROptions>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
  const { data, error } = useSWR('/api/user', fetcher)
  if (error) return <div>failed to load</div>
  if (!data) return <div>loading...</div>
  return <div>hello {data.name}!</div>
}

Type parameters​

NameType
Dataany
Errorany
SWRKeyextends Key = StrictKey
SWROptionsextends undefined | Partial<PublicConfiguration<Data, Error, Fetcher<Data, SWRKey>>> = undefined | Partial<PublicConfiguration<Data, Error, Fetcher<Data, SWRKey>>>

Parameters​

NameType
keySWRKey
configSWROptions

Returns​

SWRResponse<Data, Error, SWROptions>

Defined in​

node_modules/swr/_internal/dist/index.d.ts:202

▸ useSWR<Data, Error, SWRKey, SWROptions>(key, fetcher, config): SWRResponse<Data, Error, SWROptions>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
  const { data, error } = useSWR('/api/user', fetcher)
  if (error) return <div>failed to load</div>
  if (!data) return <div>loading...</div>
  return <div>hello {data.name}!</div>
}

Type parameters​

NameType
Dataany
Errorany
SWRKeyextends Key = StrictKey
SWROptionsextends undefined | Partial<PublicConfiguration<Data, Error, Fetcher<Data, SWRKey>>> = undefined | Partial<PublicConfiguration<Data, Error, Fetcher<Data, SWRKey>>>

Parameters​

NameType
keySWRKey
fetchernull | Fetcher<Data, SWRKey>
configSWROptions

Returns​

SWRResponse<Data, Error, SWROptions>

Defined in​

node_modules/swr/_internal/dist/index.d.ts:203

▸ useSWR<Data, Error>(key): SWRResponse<Data, Error, any>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
  const { data, error } = useSWR('/api/user', fetcher)
  if (error) return <div>failed to load</div>
  if (!data) return <div>loading...</div>
  return <div>hello {data.name}!</div>
}

Type parameters​

NameType
Dataany
Errorany

Parameters​

NameType
keyKey

Returns​

SWRResponse<Data, Error, any>

Defined in​

node_modules/swr/_internal/dist/index.d.ts:204

▸ useSWR<Data, Error>(key, fetcher): SWRResponse<Data, Error, any>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
  const { data, error } = useSWR('/api/user', fetcher)
  if (error) return <div>failed to load</div>
  if (!data) return <div>loading...</div>
  return <div>hello {data.name}!</div>
}

Type parameters​

NameType
Dataany
Errorany

Parameters​

NameType
keyKey
fetchernull | BareFetcher<Data>

Returns​

SWRResponse<Data, Error, any>

Defined in​

node_modules/swr/_internal/dist/index.d.ts:205

▸ useSWR<Data, Error, SWROptions>(key, config): SWRResponse<Data, Error, SWROptions>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
  const { data, error } = useSWR('/api/user', fetcher)
  if (error) return <div>failed to load</div>
  if (!data) return <div>loading...</div>
  return <div>hello {data.name}!</div>
}

Type parameters​

NameType
Dataany
Errorany
SWROptionsextends undefined | Partial<PublicConfiguration<Data, Error, BareFetcher<Data>>> = undefined | Partial<PublicConfiguration<Data, Error, BareFetcher<Data>>>

Parameters​

NameType
keyKey
configSWROptions

Returns​

SWRResponse<Data, Error, SWROptions>

Defined in​

node_modules/swr/_internal/dist/index.d.ts:206

▸ useSWR<Data, Error, SWROptions>(key, fetcher, config): SWRResponse<Data, Error, SWROptions>

A hook to fetch data.

Link

https://swr.vercel.app

Example

import useSWR from 'swr'
function Profile() {
  const { data, error } = useSWR('/api/user', fetcher)
  if (error) return <div>failed to load</div>
  if (!data) return <div>loading...</div>
  return <div>hello {data.name}!</div>
}

Type parameters​

NameType
Dataany
Errorany
SWROptionsextends undefined | Partial<PublicConfiguration<Data, Error, BareFetcher<Data>>> = undefined | Partial<PublicConfiguration<Data, Error, BareFetcher<Data>>>

Parameters​

NameType
keyKey
fetchernull | BareFetcher<Data>
configSWROptions

Returns​

SWRResponse<Data, Error, SWROptions>

Defined in​

node_modules/swr/_internal/dist/index.d.ts:207

useSWRConfig​

▸ useSWRConfig(): FullConfiguration<any, any, BareFetcher<unknown>>

Returns​

FullConfiguration<any, any, BareFetcher<unknown>>

Defined in​

node_modules/swr/_internal/dist/index.d.ts:336

useSettings​

▸ useSettings(): Partial<SettingsContextProps>

Returns​

Partial<SettingsContextProps>

Defined in​

packages/core/src/react/provider/useSettings.ts:4

useThemeSetting​

▸ useThemeSetting(path, blockName?, defaultValue?, fallbackToGlobalSetting?): any

Returns a single theme setting normalized

Parameters​

NameTypeDefault valueDescription
pathstringundefinedThe path to the setting
blockNamenull | string''The block name
defaultValueany''the default value to return
fallbackToGlobalSettingbooleantrueWhether it should fallback to global setting if blockName is passed but setting does not exist

Returns​

any

Defined in​

packages/core/src/react/provider/useThemeSetting.ts:22

useThemeSettings​

▸ useThemeSettings(): undefined | SettingsProperties & { blocks?: { core/archives?: SettingsPropertiesComplete ; core/audio?: SettingsPropertiesComplete ; core/block?: SettingsPropertiesComplete ; core/button?: SettingsPropertiesComplete ; core/buttons?: SettingsPropertiesComplete ; core/calendar?: SettingsPropertiesComplete ; core/categories?: SettingsPropertiesComplete ; core/code?: SettingsPropertiesComplete ; core/column?: SettingsPropertiesComplete ; core/columns?: SettingsPropertiesComplete ; core/comment-author-avatar?: SettingsPropertiesComplete ; core/comment-author-name?: SettingsPropertiesComplete ; core/comment-content?: SettingsPropertiesComplete ; core/comment-date?: SettingsPropertiesComplete ; core/comment-edit-link?: SettingsPropertiesComplete ; core/comment-reply-link?: SettingsPropertiesComplete ; core/comment-template?: SettingsPropertiesComplete ; core/comments-query-loop?: SettingsPropertiesComplete ; core/cover?: SettingsPropertiesComplete ; core/embed?: SettingsPropertiesComplete ; core/file?: SettingsPropertiesComplete ; core/freeform?: SettingsPropertiesComplete ; core/gallery?: SettingsPropertiesComplete ; core/group?: SettingsPropertiesComplete ; core/heading?: SettingsPropertiesComplete ; core/home-link?: SettingsPropertiesComplete ; core/html?: SettingsPropertiesComplete ; core/image?: SettingsPropertiesComplete ; core/latest-comments?: SettingsPropertiesComplete ; core/latest-posts?: SettingsPropertiesComplete ; core/legacy-widget?: SettingsPropertiesComplete ; core/list?: SettingsPropertiesComplete ; core/loginout?: SettingsPropertiesComplete ; core/media-text?: SettingsPropertiesComplete ; core/missing?: SettingsPropertiesComplete ; core/more?: SettingsPropertiesComplete ; core/navigation?: SettingsPropertiesComplete ; core/navigation-link?: SettingsPropertiesComplete ; core/nextpage?: SettingsPropertiesComplete ; core/page-list?: SettingsPropertiesComplete ; core/paragraph?: SettingsPropertiesComplete ; core/post-author?: SettingsPropertiesComplete ; core/post-comments?: SettingsPropertiesComplete ; core/post-comments-count?: SettingsPropertiesComplete ; core/post-comments-form?: SettingsPropertiesComplete ; core/post-comments-link?: SettingsPropertiesComplete ; core/post-content?: SettingsPropertiesComplete ; core/post-date?: SettingsPropertiesComplete ; core/post-excerpt?: SettingsPropertiesComplete ; core/post-featured-image?: SettingsPropertiesComplete ; core/post-navigation-link?: SettingsPropertiesComplete ; core/post-template?: SettingsPropertiesComplete ; core/post-terms?: SettingsPropertiesComplete ; core/post-title?: SettingsPropertiesComplete ; core/preformatted?: SettingsPropertiesComplete ; core/pullquote?: SettingsPropertiesComplete ; core/query?: SettingsPropertiesComplete ; core/query-pagination?: SettingsPropertiesComplete ; core/query-pagination-next?: SettingsPropertiesComplete ; core/query-pagination-numbers?: SettingsPropertiesComplete ; core/query-pagination-previous?: SettingsPropertiesComplete ; core/query-title?: SettingsPropertiesComplete ; core/quote?: SettingsPropertiesComplete ; core/rss?: SettingsPropertiesComplete ; core/search?: SettingsPropertiesComplete ; core/separator?: SettingsPropertiesComplete ; core/shortcode?: SettingsPropertiesComplete ; core/site-logo?: SettingsPropertiesComplete ; core/site-tagline?: SettingsPropertiesComplete ; core/site-title?: SettingsPropertiesComplete ; core/social-link?: SettingsPropertiesComplete ; core/social-links?: SettingsPropertiesComplete ; core/spacer?: SettingsPropertiesComplete ; core/table?: SettingsPropertiesComplete ; core/table-of-contents?: SettingsPropertiesComplete ; core/tag-cloud?: SettingsPropertiesComplete ; core/template-part?: SettingsPropertiesComplete ; core/term-description?: SettingsPropertiesComplete ; core/text-columns?: SettingsPropertiesComplete ; core/verse?: SettingsPropertiesComplete ; core/video?: SettingsPropertiesComplete ; core/widget-area?: SettingsPropertiesComplete ; core/widget-group?: SettingsPropertiesComplete } ; border?: { color?: boolean ; radius?: boolean ; style?: boolean ; width?: boolean } ; color?: { background?: boolean ; custom?: boolean ; customDuotone?: boolean ; customGradient?: boolean ; defaultGradients?: boolean ; defaultPalette?: boolean ; duotone?: SettingsDuotone ; gradients?: SettingsGradient ; link?: boolean ; palette?: SettingsColorPalette ; text?: boolean } ; custom?: { [k: string]: string | number | SettingsCustomAdditionalProperties; } ; layout?: { contentSize?: string ; wideSize?: string } ; spacing?: { blockGap?: null | boolean ; margin?: boolean ; padding?: boolean ; units?: string[] } ; typography?: { customFontSize?: boolean ; dropCap?: boolean ; fontFamilies?: { fontFamily?: string ; name?: string ; slug?: string }[] ; fontSizes?: { name?: string ; size?: string ; slug?: string }[] ; fontStyle?: boolean ; fontWeight?: boolean ; letterSpacing?: boolean ; lineHeight?: boolean ; textDecoration?: boolean ; textTransform?: boolean } }

Returns the raw theme.json settings definitions

Returns​

undefined | SettingsProperties & { blocks?: { core/archives?: SettingsPropertiesComplete ; core/audio?: SettingsPropertiesComplete ; core/block?: SettingsPropertiesComplete ; core/button?: SettingsPropertiesComplete ; core/buttons?: SettingsPropertiesComplete ; core/calendar?: SettingsPropertiesComplete ; core/categories?: SettingsPropertiesComplete ; core/code?: SettingsPropertiesComplete ; core/column?: SettingsPropertiesComplete ; core/columns?: SettingsPropertiesComplete ; core/comment-author-avatar?: SettingsPropertiesComplete ; core/comment-author-name?: SettingsPropertiesComplete ; core/comment-content?: SettingsPropertiesComplete ; core/comment-date?: SettingsPropertiesComplete ; core/comment-edit-link?: SettingsPropertiesComplete ; core/comment-reply-link?: SettingsPropertiesComplete ; core/comment-template?: SettingsPropertiesComplete ; core/comments-query-loop?: SettingsPropertiesComplete ; core/cover?: SettingsPropertiesComplete ; core/embed?: SettingsPropertiesComplete ; core/file?: SettingsPropertiesComplete ; core/freeform?: SettingsPropertiesComplete ; core/gallery?: SettingsPropertiesComplete ; core/group?: SettingsPropertiesComplete ; core/heading?: SettingsPropertiesComplete ; core/home-link?: SettingsPropertiesComplete ; core/html?: SettingsPropertiesComplete ; core/image?: SettingsPropertiesComplete ; core/latest-comments?: SettingsPropertiesComplete ; core/latest-posts?: SettingsPropertiesComplete ; core/legacy-widget?: SettingsPropertiesComplete ; core/list?: SettingsPropertiesComplete ; core/loginout?: SettingsPropertiesComplete ; core/media-text?: SettingsPropertiesComplete ; core/missing?: SettingsPropertiesComplete ; core/more?: SettingsPropertiesComplete ; core/navigation?: SettingsPropertiesComplete ; core/navigation-link?: SettingsPropertiesComplete ; core/nextpage?: SettingsPropertiesComplete ; core/page-list?: SettingsPropertiesComplete ; core/paragraph?: SettingsPropertiesComplete ; core/post-author?: SettingsPropertiesComplete ; core/post-comments?: SettingsPropertiesComplete ; core/post-comments-count?: SettingsPropertiesComplete ; core/post-comments-form?: SettingsPropertiesComplete ; core/post-comments-link?: SettingsPropertiesComplete ; core/post-content?: SettingsPropertiesComplete ; core/post-date?: SettingsPropertiesComplete ; core/post-excerpt?: SettingsPropertiesComplete ; core/post-featured-image?: SettingsPropertiesComplete ; core/post-navigation-link?: SettingsPropertiesComplete ; core/post-template?: SettingsPropertiesComplete ; core/post-terms?: SettingsPropertiesComplete ; core/post-title?: SettingsPropertiesComplete ; core/preformatted?: SettingsPropertiesComplete ; core/pullquote?: SettingsPropertiesComplete ; core/query?: SettingsPropertiesComplete ; core/query-pagination?: SettingsPropertiesComplete ; core/query-pagination-next?: SettingsPropertiesComplete ; core/query-pagination-numbers?: SettingsPropertiesComplete ; core/query-pagination-previous?: SettingsPropertiesComplete ; core/query-title?: SettingsPropertiesComplete ; core/quote?: SettingsPropertiesComplete ; core/rss?: SettingsPropertiesComplete ; core/search?: SettingsPropertiesComplete ; core/separator?: SettingsPropertiesComplete ; core/shortcode?: SettingsPropertiesComplete ; core/site-logo?: SettingsPropertiesComplete ; core/site-tagline?: SettingsPropertiesComplete ; core/site-title?: SettingsPropertiesComplete ; core/social-link?: SettingsPropertiesComplete ; core/social-links?: SettingsPropertiesComplete ; core/spacer?: SettingsPropertiesComplete ; core/table?: SettingsPropertiesComplete ; core/table-of-contents?: SettingsPropertiesComplete ; core/tag-cloud?: SettingsPropertiesComplete ; core/template-part?: SettingsPropertiesComplete ; core/term-description?: SettingsPropertiesComplete ; core/text-columns?: SettingsPropertiesComplete ; core/verse?: SettingsPropertiesComplete ; core/video?: SettingsPropertiesComplete ; core/widget-area?: SettingsPropertiesComplete ; core/widget-group?: SettingsPropertiesComplete } ; border?: { color?: boolean ; radius?: boolean ; style?: boolean ; width?: boolean } ; color?: { background?: boolean ; custom?: boolean ; customDuotone?: boolean ; customGradient?: boolean ; defaultGradients?: boolean ; defaultPalette?: boolean ; duotone?: SettingsDuotone ; gradients?: SettingsGradient ; link?: boolean ; palette?: SettingsColorPalette ; text?: boolean } ; custom?: { [k: string]: string | number | SettingsCustomAdditionalProperties; } ; layout?: { contentSize?: string ; wideSize?: string } ; spacing?: { blockGap?: null | boolean ; margin?: boolean ; padding?: boolean ; units?: string[] } ; typography?: { customFontSize?: boolean ; dropCap?: boolean ; fontFamilies?: { fontFamily?: string ; name?: string ; slug?: string }[] ; fontSizes?: { name?: string ; size?: string ; slug?: string }[] ; fontStyle?: boolean ; fontWeight?: boolean ; letterSpacing?: boolean ; lineHeight?: boolean ; textDecoration?: boolean ; textTransform?: boolean } }

Defined in​

packages/core/src/react/provider/useThemeSettings.ts:9

useThemeStyles​

▸ useThemeStyles(): undefined | StylesProperties & { blocks?: { core/archives?: StylesPropertiesAndElementsComplete ; core/audio?: StylesPropertiesAndElementsComplete ; core/block?: StylesPropertiesAndElementsComplete ; core/button?: StylesPropertiesAndElementsComplete ; core/buttons?: StylesPropertiesAndElementsComplete ; core/calendar?: StylesPropertiesAndElementsComplete ; core/categories?: StylesPropertiesAndElementsComplete ; core/code?: StylesPropertiesAndElementsComplete ; core/column?: StylesPropertiesAndElementsComplete ; core/columns?: StylesPropertiesAndElementsComplete ; core/comment-author-avatar?: StylesPropertiesAndElementsComplete ; core/comment-author-name?: StylesPropertiesAndElementsComplete ; core/comment-content?: StylesPropertiesAndElementsComplete ; core/comment-date?: StylesPropertiesAndElementsComplete ; core/comment-edit-link?: StylesPropertiesAndElementsComplete ; core/comment-reply-link?: StylesPropertiesAndElementsComplete ; core/comment-template?: StylesPropertiesAndElementsComplete ; core/comments-query-loop?: StylesPropertiesAndElementsComplete ; core/cover?: StylesPropertiesAndElementsComplete ; core/embed?: StylesPropertiesAndElementsComplete ; core/file?: StylesPropertiesAndElementsComplete ; core/freeform?: StylesPropertiesAndElementsComplete ; core/gallery?: StylesPropertiesAndElementsComplete ; core/group?: StylesPropertiesAndElementsComplete ; core/heading?: StylesPropertiesAndElementsComplete ; core/home-link?: StylesPropertiesAndElementsComplete ; core/html?: StylesPropertiesAndElementsComplete ; core/image?: StylesPropertiesAndElementsComplete ; core/latest-comments?: StylesPropertiesAndElementsComplete ; core/latest-posts?: StylesPropertiesAndElementsComplete ; core/legacy-widget?: StylesPropertiesAndElementsComplete ; core/list?: StylesPropertiesAndElementsComplete ; core/loginout?: StylesPropertiesAndElementsComplete ; core/media-text?: StylesPropertiesAndElementsComplete ; core/missing?: StylesPropertiesAndElementsComplete ; core/more?: StylesPropertiesAndElementsComplete ; core/navigation?: StylesPropertiesAndElementsComplete ; core/navigation-link?: StylesPropertiesAndElementsComplete ; core/nextpage?: StylesPropertiesAndElementsComplete ; core/page-list?: StylesPropertiesAndElementsComplete ; core/paragraph?: StylesPropertiesAndElementsComplete ; core/post-author?: StylesPropertiesAndElementsComplete ; core/post-comments?: StylesPropertiesAndElementsComplete ; core/post-comments-count?: StylesPropertiesAndElementsComplete ; core/post-comments-form?: StylesPropertiesAndElementsComplete ; core/post-comments-link?: StylesPropertiesAndElementsComplete ; core/post-content?: StylesPropertiesAndElementsComplete ; core/post-date?: StylesPropertiesAndElementsComplete ; core/post-excerpt?: StylesPropertiesAndElementsComplete ; core/post-featured-image?: StylesPropertiesAndElementsComplete ; core/post-navigation-link?: StylesPropertiesAndElementsComplete ; core/post-template?: StylesPropertiesAndElementsComplete ; core/post-terms?: StylesPropertiesAndElementsComplete ; core/post-title?: StylesPropertiesAndElementsComplete ; core/preformatted?: StylesPropertiesAndElementsComplete ; core/pullquote?: StylesPropertiesAndElementsComplete ; core/query?: StylesPropertiesAndElementsComplete ; core/query-pagination?: StylesPropertiesAndElementsComplete ; core/query-pagination-next?: StylesPropertiesAndElementsComplete ; core/query-pagination-numbers?: StylesPropertiesAndElementsComplete ; core/query-pagination-previous?: StylesPropertiesAndElementsComplete ; core/query-title?: StylesPropertiesAndElementsComplete ; core/quote?: StylesPropertiesAndElementsComplete ; core/rss?: StylesPropertiesAndElementsComplete ; core/search?: StylesPropertiesAndElementsComplete ; core/separator?: StylesPropertiesAndElementsComplete ; core/shortcode?: StylesPropertiesAndElementsComplete ; core/site-logo?: StylesPropertiesAndElementsComplete ; core/site-tagline?: StylesPropertiesAndElementsComplete ; core/site-title?: StylesPropertiesAndElementsComplete ; core/social-link?: StylesPropertiesAndElementsComplete ; core/social-links?: StylesPropertiesAndElementsComplete ; core/spacer?: StylesPropertiesAndElementsComplete ; core/table?: StylesPropertiesAndElementsComplete ; core/table-of-contents?: StylesPropertiesAndElementsComplete ; core/tag-cloud?: StylesPropertiesAndElementsComplete ; core/template-part?: StylesPropertiesAndElementsComplete ; core/term-description?: StylesPropertiesAndElementsComplete ; core/text-columns?: StylesPropertiesAndElementsComplete ; core/verse?: StylesPropertiesAndElementsComplete ; core/video?: StylesPropertiesAndElementsComplete ; core/widget-area?: StylesPropertiesAndElementsComplete ; core/widget-group?: StylesPropertiesAndElementsComplete } ; border?: unknown ; color?: unknown ; elements?: { h1?: StylesPropertiesComplete ; h2?: StylesPropertiesComplete ; h3?: StylesPropertiesComplete ; h4?: StylesPropertiesComplete ; h5?: StylesPropertiesComplete ; h6?: StylesPropertiesComplete ; link?: StylesPropertiesComplete } ; spacing?: unknown ; typography?: unknown }

Returns the theme.json styles definitions

Returns​

undefined | StylesProperties & { blocks?: { core/archives?: StylesPropertiesAndElementsComplete ; core/audio?: StylesPropertiesAndElementsComplete ; core/block?: StylesPropertiesAndElementsComplete ; core/button?: StylesPropertiesAndElementsComplete ; core/buttons?: StylesPropertiesAndElementsComplete ; core/calendar?: StylesPropertiesAndElementsComplete ; core/categories?: StylesPropertiesAndElementsComplete ; core/code?: StylesPropertiesAndElementsComplete ; core/column?: StylesPropertiesAndElementsComplete ; core/columns?: StylesPropertiesAndElementsComplete ; core/comment-author-avatar?: StylesPropertiesAndElementsComplete ; core/comment-author-name?: StylesPropertiesAndElementsComplete ; core/comment-content?: StylesPropertiesAndElementsComplete ; core/comment-date?: StylesPropertiesAndElementsComplete ; core/comment-edit-link?: StylesPropertiesAndElementsComplete ; core/comment-reply-link?: StylesPropertiesAndElementsComplete ; core/comment-template?: StylesPropertiesAndElementsComplete ; core/comments-query-loop?: StylesPropertiesAndElementsComplete ; core/cover?: StylesPropertiesAndElementsComplete ; core/embed?: StylesPropertiesAndElementsComplete ; core/file?: StylesPropertiesAndElementsComplete ; core/freeform?: StylesPropertiesAndElementsComplete ; core/gallery?: StylesPropertiesAndElementsComplete ; core/group?: StylesPropertiesAndElementsComplete ; core/heading?: StylesPropertiesAndElementsComplete ; core/home-link?: StylesPropertiesAndElementsComplete ; core/html?: StylesPropertiesAndElementsComplete ; core/image?: StylesPropertiesAndElementsComplete ; core/latest-comments?: StylesPropertiesAndElementsComplete ; core/latest-posts?: StylesPropertiesAndElementsComplete ; core/legacy-widget?: StylesPropertiesAndElementsComplete ; core/list?: StylesPropertiesAndElementsComplete ; core/loginout?: StylesPropertiesAndElementsComplete ; core/media-text?: StylesPropertiesAndElementsComplete ; core/missing?: StylesPropertiesAndElementsComplete ; core/more?: StylesPropertiesAndElementsComplete ; core/navigation?: StylesPropertiesAndElementsComplete ; core/navigation-link?: StylesPropertiesAndElementsComplete ; core/nextpage?: StylesPropertiesAndElementsComplete ; core/page-list?: StylesPropertiesAndElementsComplete ; core/paragraph?: StylesPropertiesAndElementsComplete ; core/post-author?: StylesPropertiesAndElementsComplete ; core/post-comments?: StylesPropertiesAndElementsComplete ; core/post-comments-count?: StylesPropertiesAndElementsComplete ; core/post-comments-form?: StylesPropertiesAndElementsComplete ; core/post-comments-link?: StylesPropertiesAndElementsComplete ; core/post-content?: StylesPropertiesAndElementsComplete ; core/post-date?: StylesPropertiesAndElementsComplete ; core/post-excerpt?: StylesPropertiesAndElementsComplete ; core/post-featured-image?: StylesPropertiesAndElementsComplete ; core/post-navigation-link?: StylesPropertiesAndElementsComplete ; core/post-template?: StylesPropertiesAndElementsComplete ; core/post-terms?: StylesPropertiesAndElementsComplete ; core/post-title?: StylesPropertiesAndElementsComplete ; core/preformatted?: StylesPropertiesAndElementsComplete ; core/pullquote?: StylesPropertiesAndElementsComplete ; core/query?: StylesPropertiesAndElementsComplete ; core/query-pagination?: StylesPropertiesAndElementsComplete ; core/query-pagination-next?: StylesPropertiesAndElementsComplete ; core/query-pagination-numbers?: StylesPropertiesAndElementsComplete ; core/query-pagination-previous?: StylesPropertiesAndElementsComplete ; core/query-title?: StylesPropertiesAndElementsComplete ; core/quote?: StylesPropertiesAndElementsComplete ; core/rss?: StylesPropertiesAndElementsComplete ; core/search?: StylesPropertiesAndElementsComplete ; core/separator?: StylesPropertiesAndElementsComplete ; core/shortcode?: StylesPropertiesAndElementsComplete ; core/site-logo?: StylesPropertiesAndElementsComplete ; core/site-tagline?: StylesPropertiesAndElementsComplete ; core/site-title?: StylesPropertiesAndElementsComplete ; core/social-link?: StylesPropertiesAndElementsComplete ; core/social-links?: StylesPropertiesAndElementsComplete ; core/spacer?: StylesPropertiesAndElementsComplete ; core/table?: StylesPropertiesAndElementsComplete ; core/table-of-contents?: StylesPropertiesAndElementsComplete ; core/tag-cloud?: StylesPropertiesAndElementsComplete ; core/template-part?: StylesPropertiesAndElementsComplete ; core/term-description?: StylesPropertiesAndElementsComplete ; core/text-columns?: StylesPropertiesAndElementsComplete ; core/verse?: StylesPropertiesAndElementsComplete ; core/video?: StylesPropertiesAndElementsComplete ; core/widget-area?: StylesPropertiesAndElementsComplete ; core/widget-group?: StylesPropertiesAndElementsComplete } ; border?: unknown ; color?: unknown ; elements?: { h1?: StylesPropertiesComplete ; h2?: StylesPropertiesComplete ; h3?: StylesPropertiesComplete ; h4?: StylesPropertiesComplete ; h5?: StylesPropertiesComplete ; h6?: StylesPropertiesComplete ; link?: StylesPropertiesComplete } ; spacing?: unknown ; typography?: unknown }

Defined in​

packages/core/src/react/provider/useThemeStyles.ts:9

React Components​

BlocksRenderer​

▸ BlocksRenderer(props): Element

The BlocksRenderer components provides an easy way to convert HTML markup into corresponding React components.

The BlocksRenderer component takes in arbitrary html markup and receives a list of react components -as children that allows replacing dom nodes with React Components.

The html prop is sanitized through wpKsesPost so it's safe for rendering arbitrary html markup.

The children components must implement the BlockProps interface

Usage​

Usage with the test function​
<BlocksRenderer html={html}>
 <MyLinkBlock test={(node) => isAnchorTag(node, { isInternalLink: true })} />
</BlocksRenderer>
Usage with classList and tagName props​
<BlocksRenderer html={html}>
  <MyLinkBlock tagName="a" classList="my-special-anchor" />
</BlocksRenderer>

Parameters​

NameTypeDescription
propsBlockRendererPropsComponent properties

Returns​

Element

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:165

HtmlDecoder​

▸ HtmlDecoder(props, context?): null | ReactElement<any, any>

The HtmlDecoder simply decodes html entities

Any actual html markup gets stripped before decoding html entities. If you need to render HTML use SafeHtml

Usage​

<HtmlDecoder html="Hello world! &#8211; foo bar &#8211;" />

Parameters​

NameTypeDescription
propsPropsWithChildren<HtmlDecodeProps>Component properties
context?any-

Returns​

null | ReactElement<any, any>

Defined in​

node_modules/@types/react/index.d.ts:542

SafeHtml​

▸ SafeHtml(props, context?): null | ReactElement<any, any>

The SafeHtml component provides an easy way to safely render HTML

The html prop is sanitized through wpKsesPost so it's safe for rendering arbitrary html markup.

Usage​

<SafeHtml html="<div><p>hello world</p> div content</div>" />

Parameters​

NameTypeDescription
propsPropsWithChildren<SafeHtmlProps>Component properties
context?any-

Returns​

null | ReactElement<any, any>

Defined in​

node_modules/@types/react/index.d.ts:542

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

Finely crafted by 10up, ©2023.

- - +as children that allows replacing dom nodes with React Components.

The html prop is sanitized through wpKsesPost so it's safe for rendering arbitrary html markup.

The children components must implement the BlockProps interface

Usage​

Usage with the test function​
<BlocksRenderer html={html}>
 <MyLinkBlock test={(node) => isAnchorTag(node, { isInternalLink: true })} />
</BlocksRenderer>
Usage with classList and tagName props​
<BlocksRenderer html={html}>
  <MyLinkBlock tagName="a" classList="my-special-anchor" />
</BlocksRenderer>

Parameters​

NameTypeDescription
propsBlockRendererPropsComponent properties

Returns​

Element

Defined in​

packages/core/src/react/components/BlocksRenderer.tsx:165

HtmlDecoder​

▸ HtmlDecoder(props, context?): null | ReactElement<any, any>

The HtmlDecoder simply decodes html entities

Any actual html markup gets stripped before decoding html entities. If you need to render HTML use SafeHtml

Usage​

<HtmlDecoder html="Hello world! &#8211; foo bar &#8211;" />

Parameters​

NameTypeDescription
propsPropsWithChildren<HtmlDecodeProps>Component properties
context?any-

Returns​

null | ReactElement<any, any>

Defined in​

node_modules/@types/react/index.d.ts:542

SafeHtml​

▸ SafeHtml(props, context?): null | ReactElement<any, any>

The SafeHtml component provides an easy way to safely render HTML

The html prop is sanitized through wpKsesPost so it's safe for rendering arbitrary html markup.

Usage​

<SafeHtml html="<div><p>hello world</p> div content</div>" />

Parameters​

NameTypeDescription
propsPropsWithChildren<SafeHtmlProps>Component properties
context?any-

Returns​

null | ReactElement<any, any>

Defined in​

node_modules/@types/react/index.d.ts:542

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/namespaces/headstartwp_next.config/index.html b/api/namespaces/headstartwp_next.config/index.html index d0b0d4fa4..c236143ed 100644 --- a/api/namespaces/headstartwp_next.config/index.html +++ b/api/namespaces/headstartwp_next.config/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Namespace: config

@headstartwp/next.config

@headstartwp/next/config​

The config export of the @headstartwp/next package.

Usage​

import { withHeadlessConfig } from '@headstartwp/next/config';

Functions​

withHeadlessConfig​

▸ withHeadlessConfig(nextConfig?, headlessConfig?, withHeadstarWPConfigOptions?): NextConfig

Parameters​

NameType
nextConfigNextConfig
headlessConfigHeadlessConfig
withHeadstarWPConfigOptionsObject
withHeadstarWPConfigOptions.injectConfigboolean

Returns​

NextConfig

Defined in​

packages/next/src/config/withHeadstartWPConfig.ts:268

withHeadstartWPConfig​

▸ withHeadstartWPConfig(nextConfig?, headlessConfig?, withHeadstarWPConfigOptions?): NextConfig

HOC used to wrap the nextjs config object with the headless config object.

Parameters​

NameTypeDescription
nextConfigNextConfigThe nextjs config object
headlessConfigHeadlessConfigThe headless config
withHeadstarWPConfigOptionsObject
withHeadstarWPConfigOptions.injectConfigboolean-

Returns​

NextConfig

Defined in​

packages/next/src/config/withHeadstartWPConfig.ts:58

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Namespace: config

@headstartwp/next.config

@headstartwp/next/config​

The config export of the @headstartwp/next package.

Usage​

import { withHeadlessConfig } from '@headstartwp/next/config';

Functions​

withHeadlessConfig​

▸ withHeadlessConfig(nextConfig?, headlessConfig?, withHeadstarWPConfigOptions?): NextConfig

Parameters​

NameType
nextConfigNextConfig
headlessConfigHeadlessConfig
withHeadstarWPConfigOptionsObject
withHeadstarWPConfigOptions.injectConfigboolean

Returns​

NextConfig

Defined in​

packages/next/src/config/withHeadstartWPConfig.ts:268

withHeadstartWPConfig​

▸ withHeadstartWPConfig(nextConfig?, headlessConfig?, withHeadstarWPConfigOptions?): NextConfig

HOC used to wrap the nextjs config object with the headless config object.

Parameters​

NameTypeDescription
nextConfigNextConfigThe nextjs config object
headlessConfigHeadlessConfigThe headless config
withHeadstarWPConfigOptionsObject
withHeadstarWPConfigOptions.injectConfigboolean-

Returns​

NextConfig

Defined in​

packages/next/src/config/withHeadstartWPConfig.ts:58

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/api/namespaces/headstartwp_next.middlewares/index.html b/api/namespaces/headstartwp_next.middlewares/index.html index 2ad5f27b4..92c80c573 100644 --- a/api/namespaces/headstartwp_next.middlewares/index.html +++ b/api/namespaces/headstartwp_next.middlewares/index.html @@ -7,13 +7,13 @@ - - + +
-
Skip to main content

Namespace: middlewares

@headstartwp/next.middlewares

@headstartwp/next/middlewares​

The middlewares export of the `@headstartwp/next' package.

Usage​

import { appMiddleware } from '@headstartwp/next/middlewares';

Functions​

AppMiddleware​

▸ AppMiddleware(req): Promise<NextResponse<unknown>>

Parameters​

NameType
reqNextRequest

Returns​

Promise<NextResponse<unknown>>

Defined in​

packages/next/src/middlewares/appMidleware.ts:15

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

- - +
Skip to main content

Namespace: middlewares

@headstartwp/next.middlewares

@headstartwp/next/middlewares​

The middlewares export of the `@headstartwp/next' package.

Usage​

import { appMiddleware } from '@headstartwp/next/middlewares';

Functions​

AppMiddleware​

▸ AppMiddleware(req): Promise<NextResponse<unknown>>

Parameters​

NameType
reqNextRequest

Returns​

Promise<NextResponse<unknown>>

Defined in​

packages/next/src/middlewares/appMidleware.ts:15

Interested in working on things like this?
Careers at 10up

Open source, MIT licensed.
Copyright © 2023

+ + \ No newline at end of file diff --git a/assets/js/0065d4a9.8d1abf5d.js b/assets/js/0065d4a9.84178906.js similarity index 99% rename from assets/js/0065d4a9.8d1abf5d.js rename to assets/js/0065d4a9.84178906.js index ed75ccce8..a5f89c8b6 100644 --- a/assets/js/0065d4a9.8d1abf5d.js +++ b/assets/js/0065d4a9.84178906.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3035],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>u});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var d=a.createContext({}),p=function(e){var t=a.useContext(d),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=p(e.components);return a.createElement(d.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,d=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),c=p(r),m=n,u=c["".concat(d,".").concat(m)]||c[m]||k[m]||i;return r?a.createElement(u,l(l({ref:t},s),{},{components:r})):a.createElement(u,l({ref:t},s))}));function u(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=m;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o[c]="string"==typeof e?e:n,l[1]=o;for(var p=2;p{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.FrameworkError",title:"Class: FrameworkError",sidebar_label:"@headstartwp/core.FrameworkError",custom_edit_url:null},l=void 0,o={unversionedId:"classes/headstartwp_core.FrameworkError",id:"classes/headstartwp_core.FrameworkError",title:"Class: FrameworkError",description:"@headstartwp/core.FrameworkError",source:"@site/docs/classes/headstartwp_core.FrameworkError.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.FrameworkError",permalink:"/docs/api/classes/headstartwp_core.FrameworkError",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.FrameworkError",title:"Class: FrameworkError",sidebar_label:"@headstartwp/core.FrameworkError",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.FetchError",permalink:"/docs/api/classes/headstartwp_core.FetchError"},next:{title:"@headstartwp/core.NotFoundError",permalink:"/docs/api/classes/headstartwp_core.NotFoundError"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"cause",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"stack",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"prepareStackTrace",id:"preparestacktrace",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],s={toc:p};function c(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".FrameworkError"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("inlineCode",{parentName:"p"},"Error")),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"FrameworkError"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new FrameworkError"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"message"),")"),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"message")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,"Error.constructor"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/errors.ts#L32"},"packages/core/src/utils/errors.ts:32")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"cause"},"cause"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"cause"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,"Error.cause"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"message"},"message"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"message"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,"Error.message"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1054"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,"Error.name"),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1053"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"stack"},"stack"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"stack"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,"Error.stack"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1055"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:127"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"preparestacktrace"},"prepareStackTrace"),(0,n.kt)("p",null,"\u25aa ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"prepareStackTrace"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"err"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"stackTraces"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"CallSite"),"[]) => ",(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"err"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"stackTraces"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("p",null,"Optional override for formatting stack traces"),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"See"))),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces"},"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces")),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"err")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Error"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"stackTraces")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"CallSite"),"[]")))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,"Error.prepareStackTrace"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:140"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"stacktracelimit"},"stackTraceLimit"),(0,n.kt)("p",null,"\u25aa ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("strong",{parentName:"p"},"stackTraceLimit"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,"Error.stackTraceLimit"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:142"),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"capturestacktrace"},"captureStackTrace"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("strong",{parentName:"p"},"captureStackTrace"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"targetObject"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"constructorOpt?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"Create .stack property on a target object"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"targetObject")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Object"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"constructorOpt?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Function"))))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,"Error.captureStackTrace"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:133"))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3035],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>u});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var d=a.createContext({}),p=function(e){var t=a.useContext(d),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=p(e.components);return a.createElement(d.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,d=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),c=p(r),m=n,u=c["".concat(d,".").concat(m)]||c[m]||k[m]||i;return r?a.createElement(u,l(l({ref:t},s),{},{components:r})):a.createElement(u,l({ref:t},s))}));function u(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=m;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o[c]="string"==typeof e?e:n,l[1]=o;for(var p=2;p{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.FrameworkError",title:"Class: FrameworkError",sidebar_label:"@headstartwp/core.FrameworkError",custom_edit_url:null},l=void 0,o={unversionedId:"classes/headstartwp_core.FrameworkError",id:"classes/headstartwp_core.FrameworkError",title:"Class: FrameworkError",description:"@headstartwp/core.FrameworkError",source:"@site/docs/classes/headstartwp_core.FrameworkError.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.FrameworkError",permalink:"/docs/api/classes/headstartwp_core.FrameworkError",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.FrameworkError",title:"Class: FrameworkError",sidebar_label:"@headstartwp/core.FrameworkError",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.FetchError",permalink:"/docs/api/classes/headstartwp_core.FetchError"},next:{title:"@headstartwp/core.NotFoundError",permalink:"/docs/api/classes/headstartwp_core.NotFoundError"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"cause",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"stack",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"prepareStackTrace",id:"preparestacktrace",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],s={toc:p};function c(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".FrameworkError"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("inlineCode",{parentName:"p"},"Error")),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"FrameworkError"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new FrameworkError"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"message"),")"),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"message")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,"Error.constructor"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/errors.ts#L32"},"packages/core/src/utils/errors.ts:32")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"cause"},"cause"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"cause"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,"Error.cause"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"message"},"message"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"message"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,"Error.message"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1054"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,"Error.name"),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1053"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"stack"},"stack"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"stack"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,"Error.stack"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1055"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:127"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"preparestacktrace"},"prepareStackTrace"),(0,n.kt)("p",null,"\u25aa ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"prepareStackTrace"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"err"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"stackTraces"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"CallSite"),"[]) => ",(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"err"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"stackTraces"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("p",null,"Optional override for formatting stack traces"),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"See"))),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces"},"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces")),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"err")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Error"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"stackTraces")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"CallSite"),"[]")))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,"Error.prepareStackTrace"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:140"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"stacktracelimit"},"stackTraceLimit"),(0,n.kt)("p",null,"\u25aa ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("strong",{parentName:"p"},"stackTraceLimit"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,"Error.stackTraceLimit"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:142"),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"capturestacktrace"},"captureStackTrace"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("strong",{parentName:"p"},"captureStackTrace"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"targetObject"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"constructorOpt?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"Create .stack property on a target object"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"targetObject")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Object"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"constructorOpt?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Function"))))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,"Error.captureStackTrace"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:133"))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/00a631a6.c183b745.js b/assets/js/00a631a6.96670176.js similarity index 97% rename from assets/js/00a631a6.c183b745.js rename to assets/js/00a631a6.96670176.js index 26e061ee7..876d41bc7 100644 --- a/assets/js/00a631a6.c183b745.js +++ b/assets/js/00a631a6.96670176.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9605],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>h});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function s(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var c=n.createContext({}),u=function(e){var t=n.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},p=function(e){var t=u(e.components);return n.createElement(c.Provider,{value:t},e.children)},l="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,c=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),l=u(r),d=a,h=l["".concat(c,".").concat(d)]||l[d]||m[d]||o;return r?n.createElement(h,s(s({ref:t},p),{},{components:r})):n.createElement(h,s({ref:t},p))}));function h(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,s=new Array(o);s[0]=d;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i[l]="string"==typeof e?e:a,s[1]=i;for(var u=2;u{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>i,toc:()=>u});var n=r(7462),a=(r(7294),r(3905));const o={slug:"/data-fetching/useterms",sidebar_position:4},s="The useTerms hook",i={unversionedId:"Data Fetching/useTerms",id:"Data Fetching/useTerms",title:"The useTerms hook",description:"The useTerms hook is the Next.js binding for the useFetchTerms.",source:"@site/documentation/02 - Data Fetching/useTerms.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/useterms",permalink:"/docs/learn/data-fetching/useterms",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/useTerms.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",sidebarPosition:4,frontMatter:{slug:"/data-fetching/useterms",sidebar_position:4},sidebar:"tutorialSidebar",previous:{title:"The usePostOrPosts hook",permalink:"/docs/learn/data-fetching/use-post-or-posts"},next:{title:"The useSearch hook",permalink:"/docs/learn/data-fetching/usesearch"}},c={},u=[{value:"Basic Usage",id:"basic-usage",level:2}],p={toc:u};function l(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"the-useterms-hook"},"The useTerms hook"),(0,a.kt)("blockquote",null,(0,a.kt)("p",{parentName:"blockquote"},"The ",(0,a.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next#useterms"},"useTerms")," hook is the Next.js binding for the ",(0,a.kt)("a",{parentName:"p",href:"/api/namespaces/headstartwp_core.react#usefetchterms"},"useFetchTerms"),".")),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"useTerms")," hook returns terms for a given WordPress taxonomy."),(0,a.kt)("h2",{id:"basic-usage"},"Basic Usage"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"const {\n data: { terms },\n} = useTerms({ taxonomy: 'category' });\n")),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"You do not need to use ",(0,a.kt)("inlineCode",{parentName:"p"},"useTerms")," if you simply need to access the term object for a taxonomy archive page (e.g category archive). You should use the ",(0,a.kt)("inlineCode",{parentName:"p"},"queriedObject")," from the ",(0,a.kt)("inlineCode",{parentName:"p"},"usePosts")," hook. See ",(0,a.kt)("a",{parentName:"p",href:"/learn/data-fetching/useposts/#queried-object"},"usePosts docs")," for more details.")))}l.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9605],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>h});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function s(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var c=n.createContext({}),u=function(e){var t=n.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},p=function(e){var t=u(e.components);return n.createElement(c.Provider,{value:t},e.children)},l="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,c=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),l=u(r),d=a,h=l["".concat(c,".").concat(d)]||l[d]||m[d]||o;return r?n.createElement(h,s(s({ref:t},p),{},{components:r})):n.createElement(h,s({ref:t},p))}));function h(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,s=new Array(o);s[0]=d;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i[l]="string"==typeof e?e:a,s[1]=i;for(var u=2;u{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>i,toc:()=>u});var n=r(7462),a=(r(7294),r(3905));const o={slug:"/data-fetching/useterms",sidebar_position:4},s="The useTerms hook",i={unversionedId:"Data Fetching/useTerms",id:"Data Fetching/useTerms",title:"The useTerms hook",description:"The useTerms hook is the Next.js binding for the useFetchTerms.",source:"@site/documentation/02 - Data Fetching/useTerms.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/useterms",permalink:"/docs/learn/data-fetching/useterms",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/useTerms.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",sidebarPosition:4,frontMatter:{slug:"/data-fetching/useterms",sidebar_position:4},sidebar:"tutorialSidebar",previous:{title:"The usePostOrPosts hook",permalink:"/docs/learn/data-fetching/use-post-or-posts"},next:{title:"The useSearch hook",permalink:"/docs/learn/data-fetching/usesearch"}},c={},u=[{value:"Basic Usage",id:"basic-usage",level:2}],p={toc:u};function l(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"the-useterms-hook"},"The useTerms hook"),(0,a.kt)("blockquote",null,(0,a.kt)("p",{parentName:"blockquote"},"The ",(0,a.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next#useterms"},"useTerms")," hook is the Next.js binding for the ",(0,a.kt)("a",{parentName:"p",href:"/api/namespaces/headstartwp_core.react#usefetchterms"},"useFetchTerms"),".")),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"useTerms")," hook returns terms for a given WordPress taxonomy."),(0,a.kt)("h2",{id:"basic-usage"},"Basic Usage"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"const {\n data: { terms },\n} = useTerms({ taxonomy: 'category' });\n")),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"You do not need to use ",(0,a.kt)("inlineCode",{parentName:"p"},"useTerms")," if you simply need to access the term object for a taxonomy archive page (e.g category archive). You should use the ",(0,a.kt)("inlineCode",{parentName:"p"},"queriedObject")," from the ",(0,a.kt)("inlineCode",{parentName:"p"},"usePosts")," hook. See ",(0,a.kt)("a",{parentName:"p",href:"/learn/data-fetching/useposts/#queried-object"},"usePosts docs")," for more details.")))}l.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/00b96e45.15e28cbe.js b/assets/js/00b96e45.87b22d26.js similarity index 83% rename from assets/js/00b96e45.15e28cbe.js rename to assets/js/00b96e45.87b22d26.js index 28d830b92..5c389dc01 100644 --- a/assets/js/00b96e45.15e28cbe.js +++ b/assets/js/00b96e45.87b22d26.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4858],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>g});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var i=a.createContext({}),s=function(e){var t=a.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},p=function(e){var t=s(e.components);return a.createElement(i.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,i=e.parentName,p=c(e,["components","mdxType","originalType","parentName"]),d=s(r),k=n,g=d["".concat(i,".").concat(k)]||d[k]||u[k]||o;return r?a.createElement(g,l(l({ref:t},p),{},{components:r})):a.createElement(g,l({ref:t},p))}));function g(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,l=new Array(o);l[0]=k;var c={};for(var i in t)hasOwnProperty.call(t,i)&&(c[i]=t[i]);c.originalType=e,c[d]="string"==typeof e?e:n,l[1]=c;for(var s=2;s{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>l,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>s});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.Colors",title:"Interface: Colors",sidebar_label:"@headstartwp/core.react.Colors",custom_edit_url:null},l=void 0,c={unversionedId:"interfaces/headstartwp_core.react.Colors",id:"interfaces/headstartwp_core.react.Colors",title:"Interface: Colors",description:"@headstartwp/core.react.Colors",source:"@site/docs/interfaces/headstartwp_core.react.Colors.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.Colors",permalink:"/docs/api/interfaces/headstartwp_core.react.Colors",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.Colors",title:"Interface: Colors",sidebar_label:"@headstartwp/core.react.Colors",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.CodeBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps"},next:{title:"@headstartwp/core.react.ColumnBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps"}},i={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"backgroundColor",id:"backgroundcolor",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"backgroundColorSlug",id:"backgroundcolorslug",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"gradient",id:"gradient",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"gradientSlug",id:"gradientslug",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"linkColor",id:"linkcolor",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"linkColorSlug",id:"linkcolorslug",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"textColor",id:"textcolor",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"textColorSlug",id:"textcolorslug",level:3},{value:"Defined in",id:"defined-in-7",level:4}],p={toc:s};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".Colors"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Colors"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.BlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"BlockAttributes"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"backgroundcolor"},"backgroundColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"backgroundColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L6"},"packages/core/src/react/blocks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"backgroundcolorslug"},"backgroundColorSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"backgroundColorSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L5"},"packages/core/src/react/blocks/types.ts:5")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"gradient"},"gradient"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"gradient"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L8"},"packages/core/src/react/blocks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"gradientslug"},"gradientSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"gradientSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L7"},"packages/core/src/react/blocks/types.ts:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"linkcolor"},"linkColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"linkColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L12"},"packages/core/src/react/blocks/types.ts:12")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"linkcolorslug"},"linkColorSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"linkColorSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L11"},"packages/core/src/react/blocks/types.ts:11")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"textcolor"},"textColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"textColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L10"},"packages/core/src/react/blocks/types.ts:10")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"textcolorslug"},"textColorSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"textColorSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L9"},"packages/core/src/react/blocks/types.ts:9")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4858],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>g});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var c=a.createContext({}),s=function(e){var t=a.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},p=function(e){var t=s(e.components);return a.createElement(c.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,c=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),d=s(r),k=n,g=d["".concat(c,".").concat(k)]||d[k]||u[k]||o;return r?a.createElement(g,l(l({ref:t},p),{},{components:r})):a.createElement(g,l({ref:t},p))}));function g(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,l=new Array(o);l[0]=k;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i[d]="string"==typeof e?e:n,l[1]=i;for(var s=2;s{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>s});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.Colors",title:"Interface: Colors",sidebar_label:"@headstartwp/core.react.Colors",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.Colors",id:"interfaces/headstartwp_core.react.Colors",title:"Interface: Colors",description:"@headstartwp/core.react.Colors",source:"@site/docs/interfaces/headstartwp_core.react.Colors.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.Colors",permalink:"/docs/api/interfaces/headstartwp_core.react.Colors",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.Colors",title:"Interface: Colors",sidebar_label:"@headstartwp/core.react.Colors",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.CodeBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps"},next:{title:"@headstartwp/core.react.ColumnBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps"}},c={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"backgroundColor",id:"backgroundcolor",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"backgroundColorSlug",id:"backgroundcolorslug",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"gradient",id:"gradient",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"gradientSlug",id:"gradientslug",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"linkColor",id:"linkcolor",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"linkColorSlug",id:"linkcolorslug",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"textColor",id:"textcolor",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"textColorSlug",id:"textcolorslug",level:3},{value:"Defined in",id:"defined-in-7",level:4}],p={toc:s};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".Colors"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Colors"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.BlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"BlockAttributes"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"backgroundcolor"},"backgroundColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"backgroundColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L6"},"packages/core/src/react/blocks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"backgroundcolorslug"},"backgroundColorSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"backgroundColorSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L5"},"packages/core/src/react/blocks/types.ts:5")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"gradient"},"gradient"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"gradient"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L8"},"packages/core/src/react/blocks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"gradientslug"},"gradientSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"gradientSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L7"},"packages/core/src/react/blocks/types.ts:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"linkcolor"},"linkColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"linkColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L12"},"packages/core/src/react/blocks/types.ts:12")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"linkcolorslug"},"linkColorSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"linkColorSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L11"},"packages/core/src/react/blocks/types.ts:11")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"textcolor"},"textColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"textColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L10"},"packages/core/src/react/blocks/types.ts:10")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"textcolorslug"},"textColorSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"textColorSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L9"},"packages/core/src/react/blocks/types.ts:9")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/01354409.c5d631b1.js b/assets/js/01354409.58b31154.js similarity index 95% rename from assets/js/01354409.c5d631b1.js rename to assets/js/01354409.58b31154.js index 808fc6b5f..28f414f95 100644 --- a/assets/js/01354409.c5d631b1.js +++ b/assets/js/01354409.58b31154.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3021],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var o=a.createContext({}),s=function(e){var t=a.useContext(o),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},c=function(e){var t=s(e.components);return a.createElement(o.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},f=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),d=s(r),f=n,m=d["".concat(o,".").concat(f)]||d[f]||u[f]||i;return r?a.createElement(m,l(l({ref:t},c),{},{components:r})):a.createElement(m,l({ref:t},c))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=f;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[d]="string"==typeof e?e:n,l[1]=p;for(var s=2;s{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>p,toc:()=>s});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.AvatarUrls",title:"Interface: AvatarUrls",sidebar_label:"@headstartwp/core.AvatarUrls",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.AvatarUrls",id:"interfaces/headstartwp_core.AvatarUrls",title:"Interface: AvatarUrls",description:"@headstartwp/core.AvatarUrls",source:"@site/docs/interfaces/headstartwp_core.AvatarUrls.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.AvatarUrls",permalink:"/docs/api/interfaces/headstartwp_core.AvatarUrls",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.AvatarUrls",title:"Interface: AvatarUrls",sidebar_label:"@headstartwp/core.AvatarUrls",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.AuthorEntity",permalink:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},next:{title:"@headstartwp/core.CommentEntity",permalink:"/docs/api/interfaces/headstartwp_core.CommentEntity"}},o={},s=[{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"24",id:"24",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"48",id:"48",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"96",id:"96",level:3},{value:"Defined in",id:"defined-in-2",level:4}],c={toc:s};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".AvatarUrls"),(0,n.kt)("p",null,"Map of avatar URLs by their size."),(0,n.kt)("h2",{id:"indexable"},"Indexable"),(0,n.kt)("p",null,"\u25aa ","[k: ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"24"},"24"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"24"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Avatar URL with image size of 24 pixels."),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L489"},"packages/core/src/data/types/entities.ts:489")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"48"},"48"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"48"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Avatar URL with image size of 48 pixels."),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L494"},"packages/core/src/data/types/entities.ts:494")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"96"},"96"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"96"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Avatar URL with image size of 96 pixels."),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L499"},"packages/core/src/data/types/entities.ts:499")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3021],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var o=a.createContext({}),s=function(e){var t=a.useContext(o),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},c=function(e){var t=s(e.components);return a.createElement(o.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},f=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),d=s(r),f=n,m=d["".concat(o,".").concat(f)]||d[f]||u[f]||i;return r?a.createElement(m,l(l({ref:t},c),{},{components:r})):a.createElement(m,l({ref:t},c))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=f;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[d]="string"==typeof e?e:n,l[1]=p;for(var s=2;s{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>p,toc:()=>s});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.AvatarUrls",title:"Interface: AvatarUrls",sidebar_label:"@headstartwp/core.AvatarUrls",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.AvatarUrls",id:"interfaces/headstartwp_core.AvatarUrls",title:"Interface: AvatarUrls",description:"@headstartwp/core.AvatarUrls",source:"@site/docs/interfaces/headstartwp_core.AvatarUrls.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.AvatarUrls",permalink:"/docs/api/interfaces/headstartwp_core.AvatarUrls",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.AvatarUrls",title:"Interface: AvatarUrls",sidebar_label:"@headstartwp/core.AvatarUrls",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.AuthorEntity",permalink:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},next:{title:"@headstartwp/core.CommentEntity",permalink:"/docs/api/interfaces/headstartwp_core.CommentEntity"}},o={},s=[{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"24",id:"24",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"48",id:"48",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"96",id:"96",level:3},{value:"Defined in",id:"defined-in-2",level:4}],c={toc:s};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".AvatarUrls"),(0,n.kt)("p",null,"Map of avatar URLs by their size."),(0,n.kt)("h2",{id:"indexable"},"Indexable"),(0,n.kt)("p",null,"\u25aa ","[k: ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"24"},"24"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"24"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Avatar URL with image size of 24 pixels."),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L489"},"packages/core/src/data/types/entities.ts:489")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"48"},"48"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"48"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Avatar URL with image size of 48 pixels."),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L494"},"packages/core/src/data/types/entities.ts:494")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"96"},"96"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"96"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Avatar URL with image size of 96 pixels."),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L499"},"packages/core/src/data/types/entities.ts:499")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/016f03e8.fac48e23.js b/assets/js/016f03e8.4f398f35.js similarity index 99% rename from assets/js/016f03e8.fac48e23.js rename to assets/js/016f03e8.4f398f35.js index 7d4f43477..8e4fd4bb6 100644 --- a/assets/js/016f03e8.fac48e23.js +++ b/assets/js/016f03e8.4f398f35.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2849],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>m});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var l=a.createContext({}),c=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=c(e.components);return a.createElement(l.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=c(n),h=i,m=u["".concat(l,".").concat(h)]||u[h]||d[h]||r;return n?a.createElement(m,o(o({ref:t},p),{},{components:n})):a.createElement(m,o({ref:t},p))}));function m(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,o=new Array(r);o[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[u]="string"==typeof e?e:i,o[1]=s;for(var c=2;c{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>c});var a=n(7462),i=(n(7294),n(3905));const r={sidebar_label:"A/B Test SPA vs MPA navigation",sidebar_position:0},o="A/B Testing SPA vs MPA navigation",s={unversionedId:"Guides/ab-test-link",id:"Guides/ab-test-link",title:"A/B Testing SPA vs MPA navigation",description:"In this guide, we\u2019ll implement a custom Link component that will replace every Link in the post content with a custom React component that will implement SPA or MPA navigation based on an A/B test. By \u201cSPA navigation\u201d I mean navigating to other pages via client-side rendering instead of a full-page reload. MPA navigation is the opposite and traditional way of navigation.",source:"@site/documentation/08-Guides/ab-test-link.md",sourceDirName:"08-Guides",slug:"/Guides/ab-test-link",permalink:"/docs/learn/Guides/ab-test-link",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/08-Guides/ab-test-link.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",sidebarPosition:0,frontMatter:{sidebar_label:"A/B Test SPA vs MPA navigation",sidebar_position:0},sidebar:"tutorialSidebar",previous:{title:"Polylang Integration",permalink:"/docs/learn/wordpress-integration/polylang"},next:{title:"Linaria (CSS-in-JS)",permalink:"/docs/learn/Guides/linaria"}},l={},c=[],p={toc:c};function u(e){let{components:t,...r}=e;return(0,i.kt)("wrapper",(0,a.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"ab-testing-spa-vs-mpa-navigation"},"A/B Testing SPA vs MPA navigation"),(0,i.kt)("p",null," In this guide, we\u2019ll implement a custom Link component that will replace every Link in the post content with a custom React component that will implement SPA or MPA navigation based on an A/B test. By \u201cSPA navigation\u201d I mean navigating to other pages via client-side rendering instead of a full-page reload. MPA navigation is the opposite and traditional way of navigation."),(0,i.kt)("p",null," This is an interesting use case since there are some claims that ",(0,i.kt)("a",{parentName:"p",href:"https://web.dev/vitals-spa-faq/"},"MPA might perform better in web vitals compared to SPA")," (not because it\u2019s necessarily better but because of difficulties to capture some metrics in SPA)."),(0,i.kt)("p",null," First off, let\u2019s create a custom LinkBlock. We\u2019ll replace the default LinkBlock component with a custom one. Note that the default LinkBlock is a special block implementation that handles internal links for Next.js."),(0,i.kt)("p",null," The starter project already has a custom ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/nicholasio/headless-tutorial/blob/trunk/src/components/Link.js"},"Link")," component that is passed via dependency injection to the Framework Provider in ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/nicholasio/headless-tutorial/blob/trunk/src/pages/_app.js#L38"},"_app.js"),". This is essentially telling the framework to use that component whenever rendering a Link."),(0,i.kt)("p",null,"So the next step here is creating our own \u201cLinkBlock\u201d implementation to use that custom link component."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},"import { Link } from './Link';\n\nconst LinkBlock = ({ domNode, children }) => {\n const { href, rel } = getAttributes(domNode.attribs);\n\n return (\n \n {children}\n \n );\n};\n\nLinkBlock.propTypes = {\n domNode: PropTypes.shape({\n attribs: PropTypes.shape({}).isRequired,\n }).isRequired,\n children: PropTypes.node.isRequired,\n};\n")),(0,i.kt)("p",null,"Our custom LinkBlock component leverages the getAttributes utility that receives the domNode attributes and returns an object with available node attributes. You could access attributes directly but this function does some normalization especially around returning className instead of class."),(0,i.kt)("p",null,"We\u2019ll leverage Next.js middleware for A/B testing. If you\u2019re unfamiliar with Next.js middleware, go read their ",(0,i.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/advanced-features/middleware"},"documentation"),"."),(0,i.kt)("p",null,"The next step is to open ",(0,i.kt)("inlineCode",{parentName:"p"},"src/middleware.js")," and make the following changes:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},"import { AppMiddleware } from '@headstartwp/next/middlewares';\nimport { NextResponse } from 'next/server';\n\nconst COOKIE_NAME = 'bucket-navigation';\nconst BUCKETS = ['spa', 'mpa'];\nconst getBucket = () => BUCKETS[Math.floor(Math.random() * BUCKETS.length)];\n\nexport async function middleware(req) {\n const response = await AppMiddleware(req);\n\n if (!response.redirected) {\n const url = req.nextUrl;\n const bucket = req.cookies.get(COOKIE_NAME) || getBucket();\n\n response.cookies.set(COOKIE_NAME, bucket);\n url.searchParams.set('navigation', bucket);\n\n req.nextUrl.searchParams.set('navigation', bucket);\n return NextResponse.rewrite(req.nextUrl, response);\n }\n\n return response;\n}\n")),(0,i.kt)("p",null,"Here, we\u2019re simply simulating an A/B test, but you could, in theory, replace getBucket with a call to an A/B testing service. This middleware is essentially adding ?navigation=type to every URL using rewrite which means users won\u2019t actually see that query param in the URL. That provides us with an easy way to check if the current request should be using SPA or MPA for navigation which we\u2019ll do directly in the Link component."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},"// src/components/Link.js\nexport const Link = ({ href, rel, children }) => {\n const { query } = useRouter();\n\n const settings = useSettings();\n const link = removeSourceUrl({ link: href, backendUrl: settings.sourceUrl || '' });\n\n const isSpaNavigation = query?.navigation === 'spa' || typeof query.navigation === 'undefined';\n\n if (isSpaNavigation) {\n return (\n \n {/* eslint-disable-next-line jsx-a11y/anchor-is-valid */}\n {children}\n \n );\n }\n\n return (\n \n {children}\n \n );\n};\n")),(0,i.kt)("p",null,"The changes to this component limit to checking the query object from the router and if the navigation param is equal to \u201cspa\u201d or undefined, in which case it will default to use the Next.js Link component. Otherwise, it defaults to an MPA by simply rendering a regular anchor tag."),(0,i.kt)("p",null,"Note that the link is converted to a relative link to remove the WordPress domain."),(0,i.kt)("p",null,"To test this, open a page. Then, check which bucket you\u2019re in"),(0,i.kt)("p",null,(0,i.kt)("img",{alt:"AB Test bucket",src:n(877).Z,width:"1024",height:"251"})),(0,i.kt)("p",null,"In the example above, I was assigned the \u201cmpa\u201d bucket I should see a full page reload when navigating to internal links inside the post content. You can change to the \u201cspa\u201d bucket by modifying the cookie."),(0,i.kt)("p",null,(0,i.kt)("img",{alt:"AB Test Link",src:n(4376).Z,width:"1444",height:"930"})))}u.isMDXComponent=!0},877:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/a-b-test-1-b1409857b5f72e1a97ec053cc775846f.png"},4376:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/a-b-testing-link-c71624b493baae52089d5258aeb43246.gif"}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2849],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>m});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var l=a.createContext({}),c=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=c(e.components);return a.createElement(l.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=c(n),h=i,m=u["".concat(l,".").concat(h)]||u[h]||d[h]||r;return n?a.createElement(m,o(o({ref:t},p),{},{components:n})):a.createElement(m,o({ref:t},p))}));function m(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,o=new Array(r);o[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[u]="string"==typeof e?e:i,o[1]=s;for(var c=2;c{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>c});var a=n(7462),i=(n(7294),n(3905));const r={sidebar_label:"A/B Test SPA vs MPA navigation",sidebar_position:0},o="A/B Testing SPA vs MPA navigation",s={unversionedId:"Guides/ab-test-link",id:"Guides/ab-test-link",title:"A/B Testing SPA vs MPA navigation",description:"In this guide, we\u2019ll implement a custom Link component that will replace every Link in the post content with a custom React component that will implement SPA or MPA navigation based on an A/B test. By \u201cSPA navigation\u201d I mean navigating to other pages via client-side rendering instead of a full-page reload. MPA navigation is the opposite and traditional way of navigation.",source:"@site/documentation/08-Guides/ab-test-link.md",sourceDirName:"08-Guides",slug:"/Guides/ab-test-link",permalink:"/docs/learn/Guides/ab-test-link",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/08-Guides/ab-test-link.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",sidebarPosition:0,frontMatter:{sidebar_label:"A/B Test SPA vs MPA navigation",sidebar_position:0},sidebar:"tutorialSidebar",previous:{title:"Polylang Integration",permalink:"/docs/learn/wordpress-integration/polylang"},next:{title:"Linaria (CSS-in-JS)",permalink:"/docs/learn/Guides/linaria"}},l={},c=[],p={toc:c};function u(e){let{components:t,...r}=e;return(0,i.kt)("wrapper",(0,a.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"ab-testing-spa-vs-mpa-navigation"},"A/B Testing SPA vs MPA navigation"),(0,i.kt)("p",null," In this guide, we\u2019ll implement a custom Link component that will replace every Link in the post content with a custom React component that will implement SPA or MPA navigation based on an A/B test. By \u201cSPA navigation\u201d I mean navigating to other pages via client-side rendering instead of a full-page reload. MPA navigation is the opposite and traditional way of navigation."),(0,i.kt)("p",null," This is an interesting use case since there are some claims that ",(0,i.kt)("a",{parentName:"p",href:"https://web.dev/vitals-spa-faq/"},"MPA might perform better in web vitals compared to SPA")," (not because it\u2019s necessarily better but because of difficulties to capture some metrics in SPA)."),(0,i.kt)("p",null," First off, let\u2019s create a custom LinkBlock. We\u2019ll replace the default LinkBlock component with a custom one. Note that the default LinkBlock is a special block implementation that handles internal links for Next.js."),(0,i.kt)("p",null," The starter project already has a custom ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/nicholasio/headless-tutorial/blob/trunk/src/components/Link.js"},"Link")," component that is passed via dependency injection to the Framework Provider in ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/nicholasio/headless-tutorial/blob/trunk/src/pages/_app.js#L38"},"_app.js"),". This is essentially telling the framework to use that component whenever rendering a Link."),(0,i.kt)("p",null,"So the next step here is creating our own \u201cLinkBlock\u201d implementation to use that custom link component."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},"import { Link } from './Link';\n\nconst LinkBlock = ({ domNode, children }) => {\n const { href, rel } = getAttributes(domNode.attribs);\n\n return (\n \n {children}\n \n );\n};\n\nLinkBlock.propTypes = {\n domNode: PropTypes.shape({\n attribs: PropTypes.shape({}).isRequired,\n }).isRequired,\n children: PropTypes.node.isRequired,\n};\n")),(0,i.kt)("p",null,"Our custom LinkBlock component leverages the getAttributes utility that receives the domNode attributes and returns an object with available node attributes. You could access attributes directly but this function does some normalization especially around returning className instead of class."),(0,i.kt)("p",null,"We\u2019ll leverage Next.js middleware for A/B testing. If you\u2019re unfamiliar with Next.js middleware, go read their ",(0,i.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/advanced-features/middleware"},"documentation"),"."),(0,i.kt)("p",null,"The next step is to open ",(0,i.kt)("inlineCode",{parentName:"p"},"src/middleware.js")," and make the following changes:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},"import { AppMiddleware } from '@headstartwp/next/middlewares';\nimport { NextResponse } from 'next/server';\n\nconst COOKIE_NAME = 'bucket-navigation';\nconst BUCKETS = ['spa', 'mpa'];\nconst getBucket = () => BUCKETS[Math.floor(Math.random() * BUCKETS.length)];\n\nexport async function middleware(req) {\n const response = await AppMiddleware(req);\n\n if (!response.redirected) {\n const url = req.nextUrl;\n const bucket = req.cookies.get(COOKIE_NAME) || getBucket();\n\n response.cookies.set(COOKIE_NAME, bucket);\n url.searchParams.set('navigation', bucket);\n\n req.nextUrl.searchParams.set('navigation', bucket);\n return NextResponse.rewrite(req.nextUrl, response);\n }\n\n return response;\n}\n")),(0,i.kt)("p",null,"Here, we\u2019re simply simulating an A/B test, but you could, in theory, replace getBucket with a call to an A/B testing service. This middleware is essentially adding ?navigation=type to every URL using rewrite which means users won\u2019t actually see that query param in the URL. That provides us with an easy way to check if the current request should be using SPA or MPA for navigation which we\u2019ll do directly in the Link component."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},"// src/components/Link.js\nexport const Link = ({ href, rel, children }) => {\n const { query } = useRouter();\n\n const settings = useSettings();\n const link = removeSourceUrl({ link: href, backendUrl: settings.sourceUrl || '' });\n\n const isSpaNavigation = query?.navigation === 'spa' || typeof query.navigation === 'undefined';\n\n if (isSpaNavigation) {\n return (\n \n {/* eslint-disable-next-line jsx-a11y/anchor-is-valid */}\n {children}\n \n );\n }\n\n return (\n \n {children}\n \n );\n};\n")),(0,i.kt)("p",null,"The changes to this component limit to checking the query object from the router and if the navigation param is equal to \u201cspa\u201d or undefined, in which case it will default to use the Next.js Link component. Otherwise, it defaults to an MPA by simply rendering a regular anchor tag."),(0,i.kt)("p",null,"Note that the link is converted to a relative link to remove the WordPress domain."),(0,i.kt)("p",null,"To test this, open a page. Then, check which bucket you\u2019re in"),(0,i.kt)("p",null,(0,i.kt)("img",{alt:"AB Test bucket",src:n(877).Z,width:"1024",height:"251"})),(0,i.kt)("p",null,"In the example above, I was assigned the \u201cmpa\u201d bucket I should see a full page reload when navigating to internal links inside the post content. You can change to the \u201cspa\u201d bucket by modifying the cookie."),(0,i.kt)("p",null,(0,i.kt)("img",{alt:"AB Test Link",src:n(4376).Z,width:"1444",height:"930"})))}u.isMDXComponent=!0},877:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/a-b-test-1-b1409857b5f72e1a97ec053cc775846f.png"},4376:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/a-b-testing-link-c71624b493baae52089d5258aeb43246.gif"}}]); \ No newline at end of file diff --git a/assets/js/042474ac.591acb40.js b/assets/js/042474ac.643f8fe3.js similarity index 97% rename from assets/js/042474ac.591acb40.js rename to assets/js/042474ac.643f8fe3.js index 01254c8cf..be8622a43 100644 --- a/assets/js/042474ac.591acb40.js +++ b/assets/js/042474ac.643f8fe3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[669],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),d=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},c=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),s=d(a),k=n,h=s["".concat(p,".").concat(k)]||s[k]||m[k]||o;return a?r.createElement(h,l(l({ref:t},c),{},{components:a})):r.createElement(h,l({ref:t},c))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,l=new Array(o);l[0]=k;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:n,l[1]=i;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.IPreformattedBlock",title:"Interface: IPreformattedBlock",sidebar_label:"@headstartwp/core.react.IPreformattedBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IPreformattedBlock",id:"interfaces/headstartwp_core.react.IPreformattedBlock",title:"Interface: IPreformattedBlock",description:"@headstartwp/core.react.IPreformattedBlock",source:"@site/docs/interfaces/headstartwp_core.react.IPreformattedBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IPreformattedBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IPreformattedBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IPreformattedBlock",title:"Interface: IPreformattedBlock",sidebar_label:"@headstartwp/core.react.IPreformattedBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IParagraphBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IParagraphBlock"},next:{title:"@headstartwp/core.react.IPullQuoteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IPullQuoteBlock"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],c={toc:d};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IPreformattedBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PreformattedBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IPreformattedBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PreformattedBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PreformattedBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[669],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),d=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},c=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),s=d(a),k=n,h=s["".concat(p,".").concat(k)]||s[k]||m[k]||o;return a?r.createElement(h,l(l({ref:t},c),{},{components:a})):r.createElement(h,l({ref:t},c))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,l=new Array(o);l[0]=k;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:n,l[1]=i;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.IPreformattedBlock",title:"Interface: IPreformattedBlock",sidebar_label:"@headstartwp/core.react.IPreformattedBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IPreformattedBlock",id:"interfaces/headstartwp_core.react.IPreformattedBlock",title:"Interface: IPreformattedBlock",description:"@headstartwp/core.react.IPreformattedBlock",source:"@site/docs/interfaces/headstartwp_core.react.IPreformattedBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IPreformattedBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IPreformattedBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IPreformattedBlock",title:"Interface: IPreformattedBlock",sidebar_label:"@headstartwp/core.react.IPreformattedBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IParagraphBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IParagraphBlock"},next:{title:"@headstartwp/core.react.IPullQuoteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IPullQuoteBlock"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],c={toc:d};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IPreformattedBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PreformattedBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IPreformattedBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PreformattedBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PreformattedBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/09026ff1.6d5ac0bd.js b/assets/js/09026ff1.626281f3.js similarity index 95% rename from assets/js/09026ff1.6d5ac0bd.js rename to assets/js/09026ff1.626281f3.js index eef0e4c2f..576daac8a 100644 --- a/assets/js/09026ff1.6d5ac0bd.js +++ b/assets/js/09026ff1.626281f3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5665],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function s(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var i=a.createContext({}),c=function(e){var t=a.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},l=function(e){var t=c(e.components);return a.createElement(i.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,i=e.parentName,l=p(e,["components","mdxType","originalType","parentName"]),d=c(r),k=n,h=d["".concat(i,".").concat(k)]||d[k]||u[k]||o;return r?a.createElement(h,s(s({ref:t},l),{},{components:r})):a.createElement(h,s({ref:t},l))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,s=new Array(o);s[0]=k;var p={};for(var i in t)hasOwnProperty.call(t,i)&&(p[i]=t[i]);p.originalType=e,p[d]="string"==typeof e?e:n,s[1]=p;for(var c=2;c{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>d,frontMatter:()=>o,metadata:()=>p,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.HookResponse",title:"Interface: HookResponse",sidebar_label:"@headstartwp/core.react.HookResponse",custom_edit_url:null},s=void 0,p={unversionedId:"interfaces/headstartwp_core.react.HookResponse",id:"interfaces/headstartwp_core.react.HookResponse",title:"Interface: HookResponse",description:"@headstartwp/core.react.HookResponse",source:"@site/docs/interfaces/headstartwp_core.react.HookResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.HookResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.HookResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.HookResponse",title:"Interface: HookResponse",sidebar_label:"@headstartwp/core.react.HookResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.HeadingBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps"},next:{title:"@headstartwp/core.react.HtmlDecodeProps",permalink:"/docs/api/interfaces/headstartwp_core.react.HtmlDecodeProps"}},i={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Defined in",id:"defined-in-3",level:4}],l={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".HookResponse"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"usePostResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"usePostsResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"useSearchResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useSearchNativeResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"useSearchNativeResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"useTermsResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"useAppSettingsResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"useMenuResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"usePostOrPostResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L5"},"packages/core/src/react/hooks/types.ts:5")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5665],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function s(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var i=a.createContext({}),c=function(e){var t=a.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},l=function(e){var t=c(e.components);return a.createElement(i.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,i=e.parentName,l=p(e,["components","mdxType","originalType","parentName"]),d=c(r),k=n,h=d["".concat(i,".").concat(k)]||d[k]||u[k]||o;return r?a.createElement(h,s(s({ref:t},l),{},{components:r})):a.createElement(h,s({ref:t},l))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,s=new Array(o);s[0]=k;var p={};for(var i in t)hasOwnProperty.call(t,i)&&(p[i]=t[i]);p.originalType=e,p[d]="string"==typeof e?e:n,s[1]=p;for(var c=2;c{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>d,frontMatter:()=>o,metadata:()=>p,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.HookResponse",title:"Interface: HookResponse",sidebar_label:"@headstartwp/core.react.HookResponse",custom_edit_url:null},s=void 0,p={unversionedId:"interfaces/headstartwp_core.react.HookResponse",id:"interfaces/headstartwp_core.react.HookResponse",title:"Interface: HookResponse",description:"@headstartwp/core.react.HookResponse",source:"@site/docs/interfaces/headstartwp_core.react.HookResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.HookResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.HookResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.HookResponse",title:"Interface: HookResponse",sidebar_label:"@headstartwp/core.react.HookResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.HeadingBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps"},next:{title:"@headstartwp/core.react.HtmlDecodeProps",permalink:"/docs/api/interfaces/headstartwp_core.react.HtmlDecodeProps"}},i={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Defined in",id:"defined-in-3",level:4}],l={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".HookResponse"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"usePostResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"usePostsResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"useSearchResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useSearchNativeResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"useSearchNativeResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"useTermsResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"useAppSettingsResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"useMenuResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"usePostOrPostResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L5"},"packages/core/src/react/hooks/types.ts:5")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/09153873.7c8e4036.js b/assets/js/09153873.11b921e8.js similarity index 93% rename from assets/js/09153873.7c8e4036.js rename to assets/js/09153873.11b921e8.js index 85edf8f53..5cc8a5f32 100644 --- a/assets/js/09153873.7c8e4036.js +++ b/assets/js/09153873.11b921e8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3182],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function s(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),d=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):s(s({},t),e)),a},o=function(e){var t=d(e.components);return n.createElement(p.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),c=d(a),u=r,k=c["".concat(p,".").concat(u)]||c[u]||h[u]||i;return a?n.createElement(k,s(s({ref:t},o),{},{components:a})):n.createElement(k,s({ref:t},o))}));function k(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,s=new Array(i);s[0]=u;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[c]="string"==typeof e?e:r,s[1]=l;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.PostsArchiveParams",title:"Interface: PostsArchiveParams",sidebar_label:"@headstartwp/core.PostsArchiveParams",custom_edit_url:null},s=void 0,l={unversionedId:"interfaces/headstartwp_core.PostsArchiveParams",id:"interfaces/headstartwp_core.PostsArchiveParams",title:"Interface: PostsArchiveParams",description:"@headstartwp/core.PostsArchiveParams",source:"@site/docs/interfaces/headstartwp_core.PostsArchiveParams.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PostsArchiveParams",permalink:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostsArchiveParams",title:"Interface: PostsArchiveParams",sidebar_label:"@headstartwp/core.PostsArchiveParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PostTypeEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},next:{title:"@headstartwp/core.Rendered",permalink:"/docs/api/interfaces/headstartwp_core.Rendered"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embed",id:"_embed",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"_fields",id:"_fields",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"author",id:"author",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"author_exclude",id:"author_exclude",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"categories",id:"categories",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"categories_exclude",id:"categories_exclude",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"category",id:"category",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"day",id:"day",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"exclude",id:"exclude",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"include",id:"include",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"lang",id:"lang",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"matchArchivePath",id:"matcharchivepath",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"month",id:"month",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"offset",id:"offset",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"order",id:"order",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"orderby",id:"orderby",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"page",id:"page",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"per_page",id:"per_page",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"postType",id:"posttype",level:3},{value:"Defined in",id:"defined-in-18",level:4},{value:"search",id:"search",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"sticky",id:"sticky",level:3},{value:"Defined in",id:"defined-in-22",level:4},{value:"tag",id:"tag",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"tags",id:"tags",level:3},{value:"Defined in",id:"defined-in-24",level:4},{value:"tags_exclude",id:"tags_exclude",level:3},{value:"Defined in",id:"defined-in-25",level:4},{value:"tax_relation",id:"tax_relation",level:3},{value:"Defined in",id:"defined-in-26",level:4},{value:"taxonomy",id:"taxonomy",level:3},{value:"Defined in",id:"defined-in-27",level:4},{value:"year",id:"year",level:3},{value:"Defined in",id:"defined-in-28",level:4}],o={toc:d};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostsArchiveParams"),(0,r.kt)("p",null,"The EndpointParams supported by the ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy")),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,r.kt)("inlineCode",{parentName:"a"},"EndpointParams"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"PostsArchiveParams"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"_embed"},"_","embed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"_","embed"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"The _embed param returned associated entities in the response"),(0,r.kt)("p",null,"It's recommended to avoid additional requests to fetch data"),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_embed"},"_embed")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L17"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_fields"},"_","fields"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"_","fields"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The _fields parameter is used to return only the specified fields in the response"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_fields"},"_fields")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L22"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"author"},"author"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"author"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Limit result set to posts assigned to specific authors."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L83"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:83")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"author_exclude"},"author","_","exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"author","_","exclude"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Ensure result set excludes posts assigned to specific authors."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L88"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:88")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"categories"},"categories"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"categories"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[] ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Limit result set to all items that have the specified term assigned in the categories taxonomy."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L156"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:156")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"categories_exclude"},"categories","_","exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"categories","_","exclude"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Limit result set to all items except those that have the specified term assigned in the categories taxonomy."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L161"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:161")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"category"},"category"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"category"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"If set will filter results by the specified category name"),(0,r.kt)("p",null,"It supports both a category id and category slug"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L44"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:44")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"day"},"day"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"day"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"If set will filter results by the specified day"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L66"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:66")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Ensure result set excludes specific IDs."),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L93"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:93")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"include"},"include"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"include"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Limit result set to specific IDs."),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L98"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:98")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"lang"},"lang"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"lang"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The polylang ?lang parameter."),(0,r.kt)("p",null,"This is only used if the polylang integration is enabled"),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#lang"},"lang")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L29"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:29")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"matcharchivepath"},"matchArchivePath"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"matchArchivePath"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Overrides the value set in CustomTaxonomy#matchArchivePath"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"false"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L190"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:190")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"month"},"month"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"month"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"If set will filter results by the specified month"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L61"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:61")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"offset"},"offset"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"offset"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Offset the result set by a specific number of items."),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L103"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:103")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"order"},"order"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"order"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"asc"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"desc"')),(0,r.kt)("p",null,"Order sort attribute ascending or descending."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"'desc'"),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L110"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:110")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"orderby"},"orderby"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"orderby"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"slug"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"date"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"modified"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"id"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"title"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"author"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"parent"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"include"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"relevance"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"include_slugs"')),(0,r.kt)("p",null,"Sort collection by object attribute."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"'date'"),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L129"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:129")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"page"},"page"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"page"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Current page of the collection."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"1"),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L37"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:37")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"per_page"},"per","_","page"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"per","_","page"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Maximum number of items to be returned in result set."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"10"),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L73"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:73")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"posttype"},"postType"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"postType"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The post type to query for."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"'post'"),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L117"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:117")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"search"},"search"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"search"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Limit results to those matching a string."),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L78"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:78")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"slug"},"slug"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Limit result set to posts with one or more specific slugs."),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L122"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:122")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"status"},"status"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"status"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Limit result set to posts assigned one or more statuses."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"'publish'"),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L146"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:146")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sticky"},"sticky"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"sticky"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Limit result set to items that are sticky."),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L183"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:183")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tag"},"tag"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tag"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"If set will filter results by the specified tag name"),(0,r.kt)("p",null,"It supports both a category id and category slug"),(0,r.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L51"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:51")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tags"},"tags"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tags"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[] ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Limit result set to all items that have the specified term assigned in the tags taxonomy."),(0,r.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L173"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:173")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tags_exclude"},"tags","_","exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tags","_","exclude"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Limit result set to all items except those that have the specified term assigned in the tags taxonomy."),(0,r.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L178"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:178")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tax_relation"},"tax","_","relation"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tax","_","relation"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"AND"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"OR"')),(0,r.kt)("p",null,"Limit result set based on relationship between multiple taxonomies."),(0,r.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L151"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:151")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"taxonomy"},"taxonomy"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"taxonomy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Limit results to a specific taxonomy and expects the actual term slug to come from the url]"),(0,r.kt)("p",null,"If you only specify the taxonomy, the term slug will be assumed to be the first segment of the path"),(0,r.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L168"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:168")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"year"},"year"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"year"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"If set will filter results by the specified year"),(0,r.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L56"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:56")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3182],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function s(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),d=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):s(s({},t),e)),a},o=function(e){var t=d(e.components);return n.createElement(p.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),c=d(a),u=r,k=c["".concat(p,".").concat(u)]||c[u]||h[u]||i;return a?n.createElement(k,s(s({ref:t},o),{},{components:a})):n.createElement(k,s({ref:t},o))}));function k(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,s=new Array(i);s[0]=u;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[c]="string"==typeof e?e:r,s[1]=l;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.PostsArchiveParams",title:"Interface: PostsArchiveParams",sidebar_label:"@headstartwp/core.PostsArchiveParams",custom_edit_url:null},s=void 0,l={unversionedId:"interfaces/headstartwp_core.PostsArchiveParams",id:"interfaces/headstartwp_core.PostsArchiveParams",title:"Interface: PostsArchiveParams",description:"@headstartwp/core.PostsArchiveParams",source:"@site/docs/interfaces/headstartwp_core.PostsArchiveParams.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PostsArchiveParams",permalink:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostsArchiveParams",title:"Interface: PostsArchiveParams",sidebar_label:"@headstartwp/core.PostsArchiveParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PostTypeEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},next:{title:"@headstartwp/core.Rendered",permalink:"/docs/api/interfaces/headstartwp_core.Rendered"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embed",id:"_embed",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"_fields",id:"_fields",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"author",id:"author",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"author_exclude",id:"author_exclude",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"categories",id:"categories",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"categories_exclude",id:"categories_exclude",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"category",id:"category",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"day",id:"day",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"exclude",id:"exclude",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"include",id:"include",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"lang",id:"lang",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"matchArchivePath",id:"matcharchivepath",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"month",id:"month",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"offset",id:"offset",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"order",id:"order",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"orderby",id:"orderby",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"page",id:"page",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"per_page",id:"per_page",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"postType",id:"posttype",level:3},{value:"Defined in",id:"defined-in-18",level:4},{value:"search",id:"search",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"sticky",id:"sticky",level:3},{value:"Defined in",id:"defined-in-22",level:4},{value:"tag",id:"tag",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"tags",id:"tags",level:3},{value:"Defined in",id:"defined-in-24",level:4},{value:"tags_exclude",id:"tags_exclude",level:3},{value:"Defined in",id:"defined-in-25",level:4},{value:"tax_relation",id:"tax_relation",level:3},{value:"Defined in",id:"defined-in-26",level:4},{value:"taxonomy",id:"taxonomy",level:3},{value:"Defined in",id:"defined-in-27",level:4},{value:"year",id:"year",level:3},{value:"Defined in",id:"defined-in-28",level:4}],o={toc:d};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostsArchiveParams"),(0,r.kt)("p",null,"The EndpointParams supported by the ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy")),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,r.kt)("inlineCode",{parentName:"a"},"EndpointParams"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"PostsArchiveParams"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"_embed"},"_","embed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"_","embed"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"The _embed param returned associated entities in the response"),(0,r.kt)("p",null,"It's recommended to avoid additional requests to fetch data"),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_embed"},"_embed")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L17"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_fields"},"_","fields"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"_","fields"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The _fields parameter is used to return only the specified fields in the response"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_fields"},"_fields")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L22"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"author"},"author"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"author"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Limit result set to posts assigned to specific authors."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L83"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:83")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"author_exclude"},"author","_","exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"author","_","exclude"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Ensure result set excludes posts assigned to specific authors."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L88"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:88")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"categories"},"categories"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"categories"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[] ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Limit result set to all items that have the specified term assigned in the categories taxonomy."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L156"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:156")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"categories_exclude"},"categories","_","exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"categories","_","exclude"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Limit result set to all items except those that have the specified term assigned in the categories taxonomy."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L161"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:161")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"category"},"category"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"category"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"If set will filter results by the specified category name"),(0,r.kt)("p",null,"It supports both a category id and category slug"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L44"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:44")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"day"},"day"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"day"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"If set will filter results by the specified day"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L66"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:66")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Ensure result set excludes specific IDs."),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L93"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:93")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"include"},"include"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"include"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Limit result set to specific IDs."),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L98"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:98")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"lang"},"lang"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"lang"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The polylang ?lang parameter."),(0,r.kt)("p",null,"This is only used if the polylang integration is enabled"),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#lang"},"lang")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L29"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:29")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"matcharchivepath"},"matchArchivePath"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"matchArchivePath"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Overrides the value set in CustomTaxonomy#matchArchivePath"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"false"),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L190"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:190")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"month"},"month"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"month"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"If set will filter results by the specified month"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L61"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:61")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"offset"},"offset"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"offset"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Offset the result set by a specific number of items."),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L103"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:103")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"order"},"order"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"order"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"asc"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"desc"')),(0,r.kt)("p",null,"Order sort attribute ascending or descending."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"'desc'"),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L110"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:110")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"orderby"},"orderby"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"orderby"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"slug"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"date"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"modified"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"id"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"title"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"author"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"parent"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"include"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"relevance"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"include_slugs"')),(0,r.kt)("p",null,"Sort collection by object attribute."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"'date'"),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L129"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:129")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"page"},"page"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"page"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Current page of the collection."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"1"),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L37"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:37")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"per_page"},"per","_","page"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"per","_","page"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Maximum number of items to be returned in result set."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"10"),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L73"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:73")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"posttype"},"postType"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"postType"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The post type to query for."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"'post'"),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L117"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:117")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"search"},"search"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"search"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Limit results to those matching a string."),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L78"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:78")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"slug"},"slug"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Limit result set to posts with one or more specific slugs."),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L122"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:122")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"status"},"status"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"status"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Limit result set to posts assigned one or more statuses."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"'publish'"),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L146"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:146")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"sticky"},"sticky"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"sticky"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Limit result set to items that are sticky."),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L183"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:183")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tag"},"tag"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tag"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"If set will filter results by the specified tag name"),(0,r.kt)("p",null,"It supports both a category id and category slug"),(0,r.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L51"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:51")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tags"},"tags"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tags"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[] ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Limit result set to all items that have the specified term assigned in the tags taxonomy."),(0,r.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L173"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:173")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tags_exclude"},"tags","_","exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tags","_","exclude"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Limit result set to all items except those that have the specified term assigned in the tags taxonomy."),(0,r.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L178"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:178")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tax_relation"},"tax","_","relation"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tax","_","relation"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"AND"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"OR"')),(0,r.kt)("p",null,"Limit result set based on relationship between multiple taxonomies."),(0,r.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L151"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:151")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"taxonomy"},"taxonomy"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"taxonomy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Limit results to a specific taxonomy and expects the actual term slug to come from the url]"),(0,r.kt)("p",null,"If you only specify the taxonomy, the term slug will be assumed to be the first segment of the path"),(0,r.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L168"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:168")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"year"},"year"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"year"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"If set will filter results by the specified year"),(0,r.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L56"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:56")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/0a88c552.243c1617.js b/assets/js/0a88c552.20a4f211.js similarity index 89% rename from assets/js/0a88c552.243c1617.js rename to assets/js/0a88c552.20a4f211.js index 8d445eb78..e148e3c6e 100644 --- a/assets/js/0a88c552.243c1617.js +++ b/assets/js/0a88c552.20a4f211.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1701],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var l=n.createContext({}),d=function(e){var t=n.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=d(e.components);return n.createElement(l.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,l=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),c=d(a),u=r,k=c["".concat(l,".").concat(u)]||c[u]||m[u]||i;return a?n.createElement(k,p(p({ref:t},o),{},{components:a})):n.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,p=new Array(i);p[0]=u;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[c]="string"==typeof e?e:r,p[1]=s;for(var d=2;d{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.TaxonomyArchiveParams",title:"Interface: TaxonomyArchiveParams",sidebar_label:"@headstartwp/core.TaxonomyArchiveParams",custom_edit_url:null},p=void 0,s={unversionedId:"interfaces/headstartwp_core.TaxonomyArchiveParams",id:"interfaces/headstartwp_core.TaxonomyArchiveParams",title:"Interface: TaxonomyArchiveParams",description:"@headstartwp/core.TaxonomyArchiveParams",source:"@site/docs/interfaces/headstartwp_core.TaxonomyArchiveParams.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.TaxonomyArchiveParams",permalink:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.TaxonomyArchiveParams",title:"Interface: TaxonomyArchiveParams",sidebar_label:"@headstartwp/core.TaxonomyArchiveParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.SearchParams",permalink:"/docs/api/interfaces/headstartwp_core.SearchParams"},next:{title:"@headstartwp/core.TaxonomyEntity",permalink:"/docs/api/interfaces/headstartwp_core.TaxonomyEntity"}},l={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embed",id:"_embed",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"_fields",id:"_fields",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"exclude",id:"exclude",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"hide_empty",id:"hide_empty",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"include",id:"include",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"lang",id:"lang",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"order",id:"order",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"orderby",id:"orderby",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"page",id:"page",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"parent",id:"parent",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"per_page",id:"per_page",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"post",id:"post",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"search",id:"search",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"taxonomy",id:"taxonomy",level:3},{value:"Defined in",id:"defined-in-14",level:4}],o={toc:d};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".TaxonomyArchiveParams"),(0,r.kt)("p",null,"The endpoint params supported by ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy"},"TaxonomyTermsStrategy")),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,r.kt)("inlineCode",{parentName:"a"},"EndpointParams"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"TaxonomyArchiveParams"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"_embed"},"_","embed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"_","embed"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"The _embed param returned associated entities in the response"),(0,r.kt)("p",null,"It's recommended to avoid additional requests to fetch data"),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_embed"},"_embed")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L17"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_fields"},"_","fields"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"_","fields"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The _fields parameter is used to return only the specified fields in the response"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_fields"},"_fields")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L22"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Ensure result set excludes specific IDs."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L49"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:49")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hide_empty"},"hide","_","empty"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"hide","_","empty"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Whether to hide terms not assigned to any posts."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L76"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:76")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"include"},"include"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"include"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Limit result set to specific IDs."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L44"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:44")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"lang"},"lang"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"lang"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The polylang ?lang parameter."),(0,r.kt)("p",null,"This is only used if the polylang integration is enabled"),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#lang"},"lang")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L29"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:29")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"order"},"order"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"order"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"asc"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"desc"')),(0,r.kt)("p",null,"Order sort attribute ascending or descending."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"'asc'"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L56"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:56")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"orderby"},"orderby"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"orderby"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"slug"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"id"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"description"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"name"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"count"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"include"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"include_slugs"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"term_group"')),(0,r.kt)("p",null,"Sort collection by term attribute."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"'name'"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L63"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:63")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"page"},"page"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"page"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Current page of the collection."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"1"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L27"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"parent"},"parent"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"parent"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Limit result set to terms assigned to a specific parent."),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L81"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:81")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"per_page"},"per","_","page"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"per","_","page"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Maximum number of items to be returned in result set."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"10"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L34"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:34")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"post"},"post"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"post"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Limit result set to terms assigned to a specific post."),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L86"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:86")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"search"},"search"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"search"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Limit results to those matching a string"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L39"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:39")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"slug"},"slug"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Limit result set to terms with one or more specific slugs."),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L91"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:91")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"taxonomy"},"taxonomy"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"taxonomy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The taxonomy the terms are to be fetched from."),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L20"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:20")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1701],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>k});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var l=n.createContext({}),o=function(e){var t=n.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},d=function(e){var t=o(e.components);return n.createElement(l.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,l=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),c=o(a),u=r,k=c["".concat(l,".").concat(u)]||c[u]||m[u]||i;return a?n.createElement(k,p(p({ref:t},d),{},{components:a})):n.createElement(k,p({ref:t},d))}));function k(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,p=new Array(i);p[0]=u;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[c]="string"==typeof e?e:r,p[1]=s;for(var o=2;o{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>o});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.TaxonomyArchiveParams",title:"Interface: TaxonomyArchiveParams",sidebar_label:"@headstartwp/core.TaxonomyArchiveParams",custom_edit_url:null},p=void 0,s={unversionedId:"interfaces/headstartwp_core.TaxonomyArchiveParams",id:"interfaces/headstartwp_core.TaxonomyArchiveParams",title:"Interface: TaxonomyArchiveParams",description:"@headstartwp/core.TaxonomyArchiveParams",source:"@site/docs/interfaces/headstartwp_core.TaxonomyArchiveParams.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.TaxonomyArchiveParams",permalink:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.TaxonomyArchiveParams",title:"Interface: TaxonomyArchiveParams",sidebar_label:"@headstartwp/core.TaxonomyArchiveParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.SearchParams",permalink:"/docs/api/interfaces/headstartwp_core.SearchParams"},next:{title:"@headstartwp/core.TaxonomyEntity",permalink:"/docs/api/interfaces/headstartwp_core.TaxonomyEntity"}},l={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embed",id:"_embed",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"_fields",id:"_fields",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"exclude",id:"exclude",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"hide_empty",id:"hide_empty",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"include",id:"include",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"lang",id:"lang",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"order",id:"order",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"orderby",id:"orderby",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"page",id:"page",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"parent",id:"parent",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"per_page",id:"per_page",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"post",id:"post",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"search",id:"search",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"taxonomy",id:"taxonomy",level:3},{value:"Defined in",id:"defined-in-14",level:4}],d={toc:o};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".TaxonomyArchiveParams"),(0,r.kt)("p",null,"The endpoint params supported by ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy"},"TaxonomyTermsStrategy")),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,r.kt)("inlineCode",{parentName:"a"},"EndpointParams"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"TaxonomyArchiveParams"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"_embed"},"_","embed"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"_","embed"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"The _embed param returned associated entities in the response"),(0,r.kt)("p",null,"It's recommended to avoid additional requests to fetch data"),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_embed"},"_embed")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L17"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"_fields"},"_","fields"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"_","fields"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The _fields parameter is used to return only the specified fields in the response"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_fields"},"_fields")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L22"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Ensure result set excludes specific IDs."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L49"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:49")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hide_empty"},"hide","_","empty"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"hide","_","empty"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Whether to hide terms not assigned to any posts."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L76"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:76")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"include"},"include"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"include"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,r.kt)("p",null,"Limit result set to specific IDs."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L44"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:44")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"lang"},"lang"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"lang"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The polylang ?lang parameter."),(0,r.kt)("p",null,"This is only used if the polylang integration is enabled"),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#lang"},"lang")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L29"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:29")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"order"},"order"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"order"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"asc"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"desc"')),(0,r.kt)("p",null,"Order sort attribute ascending or descending."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"'asc'"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L56"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:56")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"orderby"},"orderby"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"orderby"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"slug"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"id"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"description"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"name"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"count"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"include"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"include_slugs"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"term_group"')),(0,r.kt)("p",null,"Sort collection by term attribute."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"'name'"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L63"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:63")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"page"},"page"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"page"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Current page of the collection."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"1"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L27"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"parent"},"parent"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"parent"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Limit result set to terms assigned to a specific parent."),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L81"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:81")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"per_page"},"per","_","page"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"per","_","page"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Maximum number of items to be returned in result set."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,r.kt)("p",null,"10"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L34"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:34")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"post"},"post"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"post"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Limit result set to terms assigned to a specific post."),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L86"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:86")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"search"},"search"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"search"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Limit results to those matching a string"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L39"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:39")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"slug"},"slug"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Limit result set to terms with one or more specific slugs."),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L91"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:91")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"taxonomy"},"taxonomy"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"taxonomy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The taxonomy the terms are to be fetched from."),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L20"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:20")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/0dbccef1.c93896a2.js b/assets/js/0dbccef1.d264b8df.js similarity index 97% rename from assets/js/0dbccef1.c93896a2.js rename to assets/js/0dbccef1.d264b8df.js index 0d65ab80b..9dbbb0089 100644 --- a/assets/js/0dbccef1.c93896a2.js +++ b/assets/js/0dbccef1.d264b8df.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2925],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>c});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var d=n.createContext({}),o=function(e){var t=n.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},s=function(e){var t=o(e.components);return n.createElement(d.Provider,{value:t},e.children)},m="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},N=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),m=o(a),N=r,c=m["".concat(d,".").concat(N)]||m[N]||k[N]||i;return a?n.createElement(c,l(l({ref:t},s),{},{components:a})):n.createElement(c,l({ref:t},s))}));function c(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,l=new Array(i);l[0]=N;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p[m]="string"==typeof e?e:r,l[1]=p;for(var o=2;o{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>m,frontMatter:()=>i,metadata:()=>p,toc:()=>o});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core",title:"Module: @headstartwp/core",sidebar_label:"@headstartwp/core",sidebar_position:0,custom_edit_url:null},l=void 0,p={unversionedId:"modules/headstartwp_core",id:"modules/headstartwp_core",title:"Module: @headstartwp/core",description:"Namespaces",source:"@site/docs/modules/headstartwp_core.md",sourceDirName:"modules",slug:"/modules/headstartwp_core",permalink:"/docs/api/modules/headstartwp_core",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"headstartwp_core",title:"Module: @headstartwp/core",sidebar_label:"@headstartwp/core",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Table of Contents",permalink:"/docs/api/"},next:{title:"@headstartwp/next",permalink:"/docs/api/modules/headstartwp_next"}},d={},o=[{value:"Namespaces",id:"namespaces",level:2},{value:"Enumerations",id:"enumerations",level:2},{value:"Classes",id:"classes",level:2},{value:"Interfaces",id:"interfaces",level:2},{value:"DOM Helpers",id:"dom-helpers",level:2},{value:"isAnchorTag",id:"isanchortag",level:3},{value:"Usage",id:"usage",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"isBlock",id:"isblock",level:3},{value:"Usage",id:"usage-1",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isBlockByName",id:"isblockbyname",level:3},{value:"Usage",id:"usage-2",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"isImageTag",id:"isimagetag",level:3},{value:"Usage",id:"usage-3",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"isTwitterEmbed",id:"istwitterembed",level:3},{value:"Usage",id:"usage-4",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"isYoutubeEmbed",id:"isyoutubeembed",level:3},{value:"Usage",id:"usage-5",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"wpKsesPost",id:"wpksespost",level:3},{value:"Usage",id:"usage-6",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Data Fetching",id:"data-fetching",level:2},{value:"apiGet",id:"apiget",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"apiPost",id:"apipost",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"Data Handling",id:"data-handling",level:2},{value:"getPostAuthor",id:"getpostauthor",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getPostTerms",id:"getpostterms",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"Other",id:"other",level:2},{value:"CustomPostType",id:"customposttype",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"CustomPostTypes",id:"customposttypes",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"CustomTaxonomies",id:"customtaxonomies",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"CustomTaxonomy",id:"customtaxonomy",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"DOMNode",id:"domnode",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"HTMLParser2Options",id:"htmlparser2options",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"HeadlessConfig",id:"headlessconfig",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"Integrations",id:"integrations",level:3},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"Matcher",id:"matcher",level:3},{value:"Type declaration",id:"type-declaration-4",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"NormalizedDataForCache",id:"normalizeddataforcache",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Type declaration",id:"type-declaration-5",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"PostOrPostsFetchStrategyResult",id:"postorpostsfetchstrategyresult",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Type declaration",id:"type-declaration-6",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"PreviewConfig",id:"previewconfig",level:3},{value:"Type declaration",id:"type-declaration-7",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"QueriedObject",id:"queriedobject",level:3},{value:"Type declaration",id:"type-declaration-8",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"Redirect",id:"redirect",level:3},{value:"Type declaration",id:"type-declaration-9",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"RedirectData",id:"redirectdata",level:3},{value:"Type declaration",id:"type-declaration-10",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"RedirectStrategy",id:"redirectstrategy",level:3},{value:"Defined in",id:"defined-in-26",level:4},{value:"isAnchorTagOptions",id:"isanchortagoptions",level:3},{value:"Type declaration",id:"type-declaration-11",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"isBlockOptions",id:"isblockoptions",level:3},{value:"Type declaration",id:"type-declaration-12",level:4},{value:"Defined in",id:"defined-in-28",level:4},{value:"isImageTagOptions",id:"isimagetagoptions",level:3},{value:"Type declaration",id:"type-declaration-13",level:4},{value:"Defined in",id:"defined-in-29",level:4},{value:"removeSourceUrlType",id:"removesourceurltype",level:3},{value:"Type declaration",id:"type-declaration-14",level:4},{value:"Defined in",id:"defined-in-30",level:4},{value:"authorArchivesMatchers",id:"authorarchivesmatchers",level:3},{value:"Defined in",id:"defined-in-31",level:4},{value:"endpoints",id:"endpoints",level:3},{value:"Type declaration",id:"type-declaration-15",level:4},{value:"Defined in",id:"defined-in-32",level:4},{value:"ksesAllowedList",id:"ksesallowedlist",level:3},{value:"Defined in",id:"defined-in-33",level:4},{value:"postMatchers",id:"postmatchers",level:3},{value:"Defined in",id:"defined-in-34",level:4},{value:"postsMatchers",id:"postsmatchers",level:3},{value:"Defined in",id:"defined-in-35",level:4},{value:"searchMatchers",id:"searchmatchers",level:3},{value:"Defined in",id:"defined-in-36",level:4},{value:"youtubeEmbedRegex",id:"youtubeembedregex",level:3},{value:"Defined in",id:"defined-in-37",level:4},{value:"HTMLReactParser",id:"htmlreactparser",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-38",level:4},{value:"addQueryArgs",id:"addqueryargs",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-39",level:4},{value:"asyncForEach",id:"asyncforeach",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-40",level:4},{value:"attributesToProps",id:"attributestoprops",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-41",level:4},{value:"buildQueryString",id:"buildquerystring",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-42",level:4},{value:"decodeHtmlSpeciaChars",id:"decodehtmlspeciachars",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-43",level:4},{value:"domToReact",id:"domtoreact",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-44",level:4},{value:"fetchRedirect",id:"fetchredirect",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Defined in",id:"defined-in-45",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Returns",id:"returns-19",level:4},{value:"Defined in",id:"defined-in-46",level:4},{value:"getCustomPostType",id:"getcustomposttype",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-20",level:4},{value:"Defined in",id:"defined-in-47",level:4},{value:"getCustomPostTypes",id:"getcustomposttypes",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-21",level:4},{value:"Defined in",id:"defined-in-48",level:4},{value:"getCustomPostTypesSlugs",id:"getcustomposttypesslugs",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-22",level:4},{value:"Defined in",id:"defined-in-49",level:4},{value:"getCustomTaxonomies",id:"getcustomtaxonomies",level:3},{value:"Parameters",id:"parameters-22",level:4},{value:"Returns",id:"returns-23",level:4},{value:"Defined in",id:"defined-in-50",level:4},{value:"getCustomTaxonomy",id:"getcustomtaxonomy",level:3},{value:"Parameters",id:"parameters-23",level:4},{value:"Returns",id:"returns-24",level:4},{value:"Defined in",id:"defined-in-51",level:4},{value:"getCustomTaxonomySlugs",id:"getcustomtaxonomyslugs",level:3},{value:"Parameters",id:"parameters-24",level:4},{value:"Returns",id:"returns-25",level:4},{value:"Defined in",id:"defined-in-52",level:4},{value:"getHeadlessConfig",id:"getheadlessconfig",level:3},{value:"Returns",id:"returns-26",level:4},{value:"Defined in",id:"defined-in-53",level:4},{value:"getHeadstartWPConfig",id:"getheadstartwpconfig",level:3},{value:"Returns",id:"returns-27",level:4},{value:"Defined in",id:"defined-in-54",level:4},{value:"getHostUrl",id:"gethosturl",level:3},{value:"Returns",id:"returns-28",level:4},{value:"Defined in",id:"defined-in-55",level:4},{value:"getQueryArgs",id:"getqueryargs",level:3},{value:"Parameters",id:"parameters-25",level:4},{value:"Returns",id:"returns-29",level:4},{value:"Defined in",id:"defined-in-56",level:4},{value:"getQueryString",id:"getquerystring",level:3},{value:"Parameters",id:"parameters-26",level:4},{value:"Returns",id:"returns-30",level:4},{value:"Defined in",id:"defined-in-57",level:4},{value:"getSite",id:"getsite",level:3},{value:"Parameters",id:"parameters-27",level:4},{value:"Returns",id:"returns-31",level:4},{value:"Defined in",id:"defined-in-58",level:4},{value:"getSiteByHost",id:"getsitebyhost",level:3},{value:"Parameters",id:"parameters-28",level:4},{value:"Returns",id:"returns-32",level:4},{value:"Defined in",id:"defined-in-59",level:4},{value:"getSiteBySourceUrl",id:"getsitebysourceurl",level:3},{value:"Parameters",id:"parameters-29",level:4},{value:"Returns",id:"returns-33",level:4},{value:"Defined in",id:"defined-in-60",level:4},{value:"getWPUrl",id:"getwpurl",level:3},{value:"Returns",id:"returns-34",level:4},{value:"Defined in",id:"defined-in-61",level:4},{value:"htmlToDOM",id:"htmltodom",level:3},{value:"Parameters",id:"parameters-30",level:4},{value:"Returns",id:"returns-35",level:4},{value:"Defined in",id:"defined-in-62",level:4},{value:"isElement",id:"iselement",level:3},{value:"Parameters",id:"parameters-31",level:4},{value:"Returns",id:"returns-36",level:4},{value:"Defined in",id:"defined-in-63",level:4},{value:"isExternalUrl",id:"isexternalurl",level:3},{value:"Parameters",id:"parameters-32",level:4},{value:"Returns",id:"returns-37",level:4},{value:"Defined in",id:"defined-in-64",level:4},{value:"isInternalLink",id:"isinternallink",level:3},{value:"Parameters",id:"parameters-33",level:4},{value:"Returns",id:"returns-38",level:4},{value:"Defined in",id:"defined-in-65",level:4},{value:"log",id:"log",level:3},{value:"Parameters",id:"parameters-34",level:4},{value:"Returns",id:"returns-39",level:4},{value:"Defined in",id:"defined-in-66",level:4},{value:"removeFieldsFromPostRelatedData",id:"removefieldsfrompostrelateddata",level:3},{value:"Parameters",id:"parameters-35",level:4},{value:"Returns",id:"returns-40",level:4},{value:"Defined in",id:"defined-in-67",level:4},{value:"removeSourceUrl",id:"removesourceurl",level:3},{value:"Parameters",id:"parameters-36",level:4},{value:"Returns",id:"returns-41",level:4},{value:"Defined in",id:"defined-in-68",level:4},{value:"setHeadlessConfig",id:"setheadlessconfig",level:3},{value:"Parameters",id:"parameters-37",level:4},{value:"Returns",id:"returns-42",level:4},{value:"Defined in",id:"defined-in-69",level:4},{value:"setHeadstartWPConfig",id:"setheadstartwpconfig",level:3},{value:"Parameters",id:"parameters-38",level:4},{value:"Returns",id:"returns-43",level:4},{value:"Defined in",id:"defined-in-70",level:4},{value:"stripTags",id:"striptags",level:3},{value:"Parameters",id:"parameters-39",level:4},{value:"Returns",id:"returns-44",level:4},{value:"Defined in",id:"defined-in-71",level:4},{value:"warn",id:"warn",level:3},{value:"Parameters",id:"parameters-40",level:4},{value:"Returns",id:"returns-45",level:4},{value:"Defined in",id:"defined-in-72",level:4},{value:"Utility Functions",id:"utility-functions",level:2},{value:"parsePath",id:"parsepath",level:3},{value:"Parameters",id:"parameters-41",level:4},{value:"Returns",id:"returns-46",level:4},{value:"Defined in",id:"defined-in-73",level:4}],s={toc:o};function m(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"namespaces"},"Namespaces"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/namespaces/headstartwp_core.react"},"react"))),(0,r.kt)("h2",{id:"enumerations"},"Enumerations"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/enums/headstartwp_core.LOGTYPE"},"LOGTYPE"))),(0,r.kt)("h2",{id:"classes"},"Classes"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.AppSettingsStrategy"},"AppSettingsStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy"},"AuthorArchiveFetchStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.Comment"},"Comment")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.ConfigError"},"ConfigError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.Element"},"Element")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.EndpointError"},"EndpointError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.FetchError"},"FetchError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.FrameworkError"},"FrameworkError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.NotFoundError"},"NotFoundError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy"},"PostOrPostsFetchStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.ProcessingInstruction"},"ProcessingInstruction")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.SearchFetchStrategy"},"SearchFetchStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.SearchNativeFetchStrategy"},"SearchNativeFetchStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy"},"SinglePostFetchStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy"},"TaxonomyTermsStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.Text"},"Text")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy"},"VerifyTokenFetchStrategy"))),(0,r.kt)("h2",{id:"interfaces"},"Interfaces"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},"AppEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.AttachmentEntity"},"AttachmentEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},"AuthorEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.AvatarUrls"},"AvatarUrls")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.CommentEntity"},"CommentEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},"FetchOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},"FetchResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},"FilterDataOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions"},"HTMLReactParserOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.Integration"},"Integration")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"},"MenuItemEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PageEntity"},"PageEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},"PageInfo")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PolylangIntegration"},"PolylangIntegration")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},"PostEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},"PostOrPostsParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PostParams"},"PostParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"},"PostSearchEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},"PostsArchiveParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.Rendered"},"Rendered")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.RevisionEntity"},"RevisionEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.SearchEntity"},"SearchEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},"SearchObjectEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.SearchParams"},"SearchParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},"TaxonomyArchiveParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.TaxonomyEntity"},"TaxonomyEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},"TermEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.TermSearchEntity"},"TermSearchEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.TypeEntity"},"TypeEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams"},"VerifyTokenParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.YoastSEOIntegration"},"YoastSEOIntegration"))),(0,r.kt)("h2",{id:"dom-helpers"},"DOM Helpers"),(0,r.kt)("h3",{id:"isanchortag"},"isAnchorTag"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isAnchorTag"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): node is Element"),(0,r.kt)("p",null,"Checks if the provided node is an valid anchor tag"),(0,r.kt)("p",null,"This function expects to be used with ",(0,r.kt)("inlineCode",{parentName:"p"},"DOMNode")," objects from ",(0,r.kt)("inlineCode",{parentName:"p"},"html-react-parser"),", which is\nthe underlying parser used by BlocksRenderer."),(0,r.kt)("h4",{id:"usage"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { isAnchorTag } from '@headstartwp/core';\nimport { LinkBlock } from '@10up/headless-next';\n\n\n isAnchorTag(node, { isInternalLink: true})} />\n\n")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The node to test")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#isanchortagoptions"},(0,r.kt)("inlineCode",{parentName:"a"},"isAnchorTagOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Supported options")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"})))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,"node is Element"),(0,r.kt)("p",null,"Whether it's an anchor tag according to the options passed"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/dom/index.ts#L77"},"packages/core/src/dom/index.ts:77")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isblock"},"isBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"_options"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Tests a node by tagName and/or className"),(0,r.kt)("p",null,"This function expects to be used with ",(0,r.kt)("inlineCode",{parentName:"p"},"DOMNode")," objects from ",(0,r.kt)("inlineCode",{parentName:"p"},"html-react-parser"),", which is\nthe underlying parser used by BlocksRenderer."),(0,r.kt)("h4",{id:"usage-1"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { isBlock } from '@headstartwp/core';\n\n\n isBlock(node, { tagName: 'div', classList: ['block-class-name'] })}\n />\n\n")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The node to test")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"_options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#isblockoptions"},(0,r.kt)("inlineCode",{parentName:"a"},"isBlockOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"})))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"true if the node passes the test"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/dom/index.ts#L278"},"packages/core/src/dom/index.ts:278")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isblockbyname"},"isBlockByName"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isBlockByName"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"name"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Tests a node by block name. This requires the Headless WP Plugin to be installed."),(0,r.kt)("p",null,"The Headless WP Plugin will append ",(0,r.kt)("inlineCode",{parentName:"p"},"data-wp-block-name")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"data-wp-block")," to every block,\nthis function relies on those attributes to determine if the node is a block."),(0,r.kt)("p",null,"This function expects to be used with ",(0,r.kt)("inlineCode",{parentName:"p"},"DOMNode")," objects from ",(0,r.kt)("inlineCode",{parentName:"p"},"html-react-parser"),", which is\nthe underlying parser used by BlocksRenderer."),(0,r.kt)("h4",{id:"usage-2"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { isBlockByName } from '@headstartwp/core';\n\n\n isBlock(node, 'core/paragraph')}\n />\n\n")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The node to test")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The block name")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"true if the node passes the test"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/dom/index.ts#L334"},"packages/core/src/dom/index.ts:334")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isimagetag"},"isImageTag"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isImageTag"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Checks if the provided node is an valid image tag"),(0,r.kt)("p",null,"This function expects to be used with ",(0,r.kt)("inlineCode",{parentName:"p"},"DOMNode")," objects from ",(0,r.kt)("inlineCode",{parentName:"p"},"html-react-parser"),", which is\nthe underlying parser used by BlocksRenderer."),(0,r.kt)("h4",{id:"usage-3"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { isImageTag, ImageBlock } from '@headstartwp/core';\nimport { ImageComponent } from '@10up/headless-next';\n\n\n isImageTag(node, { hasDimensions: true})}\n component={ImageComponent}\n />\n\n")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The node to test")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#isimagetagoptions"},(0,r.kt)("inlineCode",{parentName:"a"},"isImageTagOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Supported options.")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Whether it's an image tag or not according to the options passed"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/dom/index.ts#L141"},"packages/core/src/dom/index.ts:141")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"istwitterembed"},"isTwitterEmbed"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isTwitterEmbed"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Checks if the node is an twitter embed"),(0,r.kt)("p",null,"This function expects to be used with ",(0,r.kt)("inlineCode",{parentName:"p"},"DOMNode")," objects from ",(0,r.kt)("inlineCode",{parentName:"p"},"html-react-parser"),", which is\nthe underlying parser used by BlocksRenderer."),(0,r.kt)("h4",{id:"usage-4"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { isTwitterEmbed } from '@headstartwp/core';\n\n\n \n\n")),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The node to test")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"true if the node is a twitter embed"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/dom/index.ts#L227"},"packages/core/src/dom/index.ts:227")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isyoutubeembed"},"isYoutubeEmbed"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isYoutubeEmbed"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Checks if the node is an youtube embed"),(0,r.kt)("p",null,"This function expects to be used with ",(0,r.kt)("inlineCode",{parentName:"p"},"DOMNode")," objects from ",(0,r.kt)("inlineCode",{parentName:"p"},"html-react-parser"),", which is\nthe underlying parser used by BlocksRenderer."),(0,r.kt)("h4",{id:"usage-5"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { isYoutubeEmbed } from '@headstartwp/core';\n\n\n \n\n")),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The node to test")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"true if the node is a youtube embed"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/dom/index.ts#L187"},"packages/core/src/dom/index.ts:187")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"wpksespost"},"wpKsesPost"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"wpKsesPost"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"content"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"allowList?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Sanitize HTML content by the wp_kses_post() requirements"),(0,r.kt)("h4",{id:"usage-6"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { wpKsesPost } from '@headstartwp/core';\nwpKsesPost(html);\n")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://codex.wordpress.org/Function_Reference/wp_kses_post"},"https://codex.wordpress.org/Function_Reference/wp_kses_post")),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"content")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The content to sanitize.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"allowList?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"IWhiteList")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Optional. The list of allowed HTML tags and attributes. If not set, the default allow list will be used.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"IWpKsesPostOptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Optional. IWpKsesPostOptions.")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Sanitized string of HTML."),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/dom/wpKsesPost.ts#L30"},"packages/core/src/dom/wpKsesPost.ts:30")),(0,r.kt)("h2",{id:"data-fetching"},"Data Fetching"),(0,r.kt)("h3",{id:"apiget"},"apiGet"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"apiGet"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"args?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"burstCache?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"headers"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"[index: string]"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),"; } = receivedHeaders; ",(0,r.kt)("inlineCode",{parentName:"p"},"json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," }",">"),(0,r.kt)("p",null,"Fetch Wrapper to handle GET requests."),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The URL where to make the request to")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The arguments")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"burstCache")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Whether it should burst cache")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"headers"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"[index: string]"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),"; } = receivedHeaders; ",(0,r.kt)("inlineCode",{parentName:"p"},"json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," }",">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/api/fetch-utils.ts#L46"},"packages/core/src/data/api/fetch-utils.ts:46")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"apipost"},"apiPost"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"apiPost"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"args?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Fetch Wrapper to handle POST requests"),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The URL where to make the request to")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The arguments")))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/api/fetch-utils.ts#L17"},"packages/core/src/data/api/fetch-utils.ts:17")),(0,r.kt)("h2",{id:"data-handling"},"Data Handling"),(0,r.kt)("h3",{id:"getpostauthor"},"getPostAuthor"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getPostAuthor"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"post"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,r.kt)("p",null,"Returns the author object from the post object if it exists"),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"post")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostSearchEntity"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The Post object")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/utils/postHandling.ts#L11"},"packages/core/src/data/utils/postHandling.ts:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getpostterms"},"getPostTerms"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getPostTerms"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"post"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,r.kt)("p",null,"Returns the terms associated with the post"),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"post")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostSearchEntity"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The Post object")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/utils/postHandling.ts#L22"},"packages/core/src/data/utils/postHandling.ts:22")),(0,r.kt)("h2",{id:"other"},"Other"),(0,r.kt)("h3",{id:"customposttype"},"CustomPostType"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"CustomPostType"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"archive?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"matchSinglePath?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Whether this custom post type should match the archive path If set to true, then when querying a post type archive page such as ",(0,r.kt)("inlineCode",{parentName:"td"},"/[post-type]/[post-name]")," the ",(0,r.kt)("inlineCode",{parentName:"td"},"post.link")," property should match the current path. This will avoid matching nested posts/pages that doesn't exist for instance: ",(0,r.kt)("inlineCode",{parentName:"td"},"/[post-type]/fake-parent-page/[post-name]")," will not match if this option is set to true even though ",(0,r.kt)("inlineCode",{parentName:"td"},"post-name")," exists. It is strongly recommended to set this option to true, otherwise hierarchical post types (such as pages) will not work properly. ",(0,r.kt)("strong",{parentName:"td"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))," true")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"single?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/types.ts#L1"},"packages/core/src/types.ts:1")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"customposttypes"},"CustomPostTypes"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"CustomPostTypes"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customposttype"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostType")),"[]"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/types.ts#L21"},"packages/core/src/types.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"customtaxonomies"},"CustomTaxonomies"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"CustomTaxonomies"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customtaxonomy"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomy")),"[]"),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/types.ts#L43"},"packages/core/src/types.ts:43")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"customtaxonomy"},"CustomTaxonomy"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"CustomTaxonomy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"matchArchivePath?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Whether this custom taxonomy should match the archive path If set to true, then when querying a taxonomy archive page such as ",(0,r.kt)("inlineCode",{parentName:"td"},"/[taxonmy-slug]/[term-slug]")," the ",(0,r.kt)("inlineCode",{parentName:"td"},"term.link")," property should match the current path. This will avoid matching nested categories that doesn't exist for instance: ",(0,r.kt)("inlineCode",{parentName:"td"},"/[taxonmy-slug]/fake-parent-term/[term-slug]")," will not match if this option is set to true even though ",(0,r.kt)("inlineCode",{parentName:"td"},"term-slug")," exists. ",(0,r.kt)("strong",{parentName:"td"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))," false")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"restParam?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"rewrite?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/types.ts#L25"},"packages/core/src/types.ts:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domnode"},"DOMNode"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"DOMNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Comment"},(0,r.kt)("inlineCode",{parentName:"a"},"Comment"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Node")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.ProcessingInstruction"},(0,r.kt)("inlineCode",{parentName:"a"},"ProcessingInstruction"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Text"},(0,r.kt)("inlineCode",{parentName:"a"},"Text"))),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,"node_modules/html-react-parser/index.d.ts:21"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"htmlparser2options"},"HTMLParser2Options"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HTMLParser2Options"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ParserOptions")," & ",(0,r.kt)("inlineCode",{parentName:"p"},"DomHandlerOptions")),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,"node_modules/html-react-parser/index.d.ts:19"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"headlessconfig"},"HeadlessConfig"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HeadlessConfig"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customPostTypes?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customposttypes"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostTypes"))," ","|"," (",(0,r.kt)("inlineCode",{parentName:"td"},"defaultPostTypes"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customposttypes"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostTypes")),") => ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customposttypes"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostTypes")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customTaxonomies?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customtaxonomies"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomies"))," ","|"," (",(0,r.kt)("inlineCode",{parentName:"td"},"defaultTaxonomies"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customtaxonomies"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomies")),") => ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customtaxonomies"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomies")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"debug?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"devMode?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"redirects?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"requests?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"debug.devMode?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"debug.redirects?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"debug.requests?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"host?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hostUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"integrations?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#integrations"},(0,r.kt)("inlineCode",{parentName:"a"},"Integrations")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"locale?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"preview?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#previewconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewConfig")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"redirectStrategy?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#redirectstrategy"},(0,r.kt)("inlineCode",{parentName:"a"},"RedirectStrategy")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sites?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"useWordPressPlugin?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/types.ts#L73"},"packages/core/src/types.ts:73")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"integrations"},"Integrations"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Integrations"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"polylang?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PolylangIntegration"},(0,r.kt)("inlineCode",{parentName:"a"},"PolylangIntegration")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"yoastSEO?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.YoastSEOIntegration"},(0,r.kt)("inlineCode",{parentName:"a"},"YoastSEOIntegration")))))),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/types.ts#L53"},"packages/core/src/types.ts:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"matcher"},"Matcher"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Matcher"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-4"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pattern")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"priority")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/utils/matchers.ts#L1"},"packages/core/src/data/utils/matchers.ts:1")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"normalizeddataforcache"},"NormalizedDataForCache"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"NormalizedDataForCache"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P"))))),(0,r.kt)("h4",{id:"type-declaration-5"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"additionalCacheObjects?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,r.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">","[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"url"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key.args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key.url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L97"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:97")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"postorpostsfetchstrategyresult"},"PostOrPostsFetchStrategyResult"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"PostOrPostsFetchStrategyResult"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))))),(0,r.kt)("h4",{id:"type-declaration-6"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isArchive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isSingle")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L42"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:42")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"previewconfig"},"PreviewConfig"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"PreviewConfig"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-7"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"alternativeAuthorizationHeader?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Flag to enable using the alternative authorization header. This can be useful if you have separate JWT-based authentication on your project.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"usePostLinkForRedirect?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If enabled, it will use the ",(0,r.kt)("inlineCode",{parentName:"td"},"post.link")," property of the REST response to redirect to the appropriate route for previewing")))),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/types.ts#L58"},"packages/core/src/types.ts:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"queriedobject"},"QueriedObject"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"QueriedObject"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The QueriedObject represents the object that the current requests is subjected to."),(0,r.kt)("p",null,"Querying by taxonomy and/or author will set the queried object."),(0,r.kt)("h4",{id:"type-declaration-8"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"author?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"If the request is an author query, this will be populated with the author object")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"search?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.SearchEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"SearchEntity"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"If the request is a search query, this will be populated with the search entity object")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"term?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"If the request is a term query, this will be populated with the term object")))),(0,r.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L765"},"packages/core/src/data/types/entities.ts:765")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"redirect"},"Redirect"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Redirect"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-9"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ID")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"enable_regex")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"post_status")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"redirect_from")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"redirect_to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"status_code")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L705"},"packages/core/src/data/types/entities.ts:705")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"redirectdata"},"RedirectData"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"RedirectData"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-10"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"location")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"null")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The redirect new location will be null if no redirect is found")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"status")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The status number of the redirect Will be 0 if the redirect is not found")))),(0,r.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/fetchRedirect.ts#L5"},"packages/core/src/utils/fetchRedirect.ts:5")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"redirectstrategy"},"RedirectStrategy"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"RedirectStrategy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"404"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"none"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"always"')),(0,r.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/types.ts#L23"},"packages/core/src/types.ts:23")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isanchortagoptions"},"isAnchorTagOptions"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"isAnchorTagOptions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-11"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isInternalLink?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},'If true, will check if the anchor tag contains a valid internal link. if target="_blank" then this option is not taken into account')))),(0,r.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/dom/index.ts#L5"},"packages/core/src/dom/index.ts:5")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isblockoptions"},"isBlockOptions"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"isBlockOptions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-12"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"className?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"A single or array of classNames to check for If an array of class names is passed, the block will be considered valid if all of the class names are found")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tagName?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The tagName to check for")))),(0,r.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/dom/index.ts#L238"},"packages/core/src/dom/index.ts:238")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isimagetagoptions"},"isImageTagOptions"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"isImageTagOptions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-13"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hasDimensions?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If true, will check if the image tag contains width and height attributes")))),(0,r.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/dom/index.ts#L107"},"packages/core/src/dom/index.ts:107")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removesourceurltype"},"removeSourceUrlType"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"removeSourceUrlType"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-14"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"backendUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The backend url.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"link")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The link url, possibly with the source url.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"nonEmptyLink?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If the removal of source url from link leads to a empty string, this setting control whether a '/' should be returned or the empty string")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"publicUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The public url. Defaults to '/'.")))),(0,r.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/removeSourceUrl.ts#L3"},"packages/core/src/utils/removeSourceUrl.ts:3")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"authorarchivesmatchers"},"authorArchivesMatchers"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"authorArchivesMatchers"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#matcher"},(0,r.kt)("inlineCode",{parentName:"a"},"Matcher")),"[]"),(0,r.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/utils/matchers.ts#L43"},"packages/core/src/data/utils/matchers.ts:43")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"endpoints"},"endpoints"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"endpoints"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-15"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"appSettings")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"category")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pages")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"posts")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"search")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tags")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tokenVerify")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"yoast")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/endpoints.ts#L1"},"packages/core/src/utils/endpoints.ts:1")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ksesallowedlist"},"ksesAllowedList"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"ksesAllowedList"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"IWhiteList")),(0,r.kt)("p",null,"Default Allowed HTML Attributes"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://codex.wordpress.org/Function_Reference/wp_kses_post"},"https://codex.wordpress.org/Function_Reference/wp_kses_post")),(0,r.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/dom/wpKsesPost.ts#L266"},"packages/core/src/dom/wpKsesPost.ts:266")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"postmatchers"},"postMatchers"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"postMatchers"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#matcher"},(0,r.kt)("inlineCode",{parentName:"a"},"Matcher")),"[]"),(0,r.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/utils/matchers.ts#L7"},"packages/core/src/data/utils/matchers.ts:7")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"postsmatchers"},"postsMatchers"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"postsMatchers"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#matcher"},(0,r.kt)("inlineCode",{parentName:"a"},"Matcher")),"[]"),(0,r.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/utils/matchers.ts#L20"},"packages/core/src/data/utils/matchers.ts:20")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"searchmatchers"},"searchMatchers"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"searchMatchers"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#matcher"},(0,r.kt)("inlineCode",{parentName:"a"},"Matcher")),"[]"),(0,r.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/utils/matchers.ts#L56"},"packages/core/src/data/utils/matchers.ts:56")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"youtubeembedregex"},"youtubeEmbedRegex"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"youtubeEmbedRegex"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"RegExp")),(0,r.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/dom/index.ts#L160"},"packages/core/src/dom/index.ts:160")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"htmlreactparser"},"HTMLReactParser"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"HTMLReactParser"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"html"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"ReturnType"),""),(0,r.kt)("p",null,"Converts HTML string to JSX element(s)."),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"html")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"HTML string.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"HTMLReactParserOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Parser options.")))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"ReturnType"),""),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"JSX element(s), empty array, or string.")),(0,r.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,r.kt)("p",null,"node_modules/html-react-parser/index.d.ts:51"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"addqueryargs"},"addQueryArgs"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"addQueryArgs"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"args"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"parameters-12"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-39"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/url.ts#L167"},"packages/core/src/utils/url.ts:167")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"asyncforeach"},"asyncForEach"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"asyncForEach"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"array"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"callback"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"parameters-13"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"array")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"callback")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"el"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"index"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"array"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),"[]) => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-40"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/asyncForEach.ts#L1"},"packages/core/src/utils/asyncForEach.ts:1")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"attributestoprops"},"attributesToProps"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"attributesToProps"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"attributes"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"nodeName?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Props")),(0,r.kt)("p",null,"Converts HTML/SVG DOM attributes to React props."),(0,r.kt)("h4",{id:"parameters-14"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"attributes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Attributes")),(0,r.kt)("td",{parentName:"tr",align:"left"},"HTML/SVG DOM attributes.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"nodeName?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"DOM node name.")))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Props")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"React props.")),(0,r.kt)("h4",{id:"defined-in-41"},"Defined in"),(0,r.kt)("p",null,"node_modules/html-react-parser/lib/attributes-to-props.d.ts:17"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"buildquerystring"},"buildQueryString"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"buildQueryString"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Generates URL-encoded query string using input query data."),(0,r.kt)("p",null,"It is intended to behave equivalent as PHP's ",(0,r.kt)("inlineCode",{parentName:"p"},"http_build_query"),", configured\nwith encoding type PHP_QUERY_RFC3986 (spaces as ",(0,r.kt)("inlineCode",{parentName:"p"},"%20"),")."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const queryString = buildQueryString( {\n simple: 'is ok',\n arrays: [ 'are', 'fine', 'too' ],\n objects: {\n evenNested: {\n ok: 'yes',\n },\n },\n} );\n// \"simple=is%20ok&arrays%5B0%5D=are&arrays%5B1%5D=fine&arrays%5B2%5D=too&objects%5BevenNested%5D%5Bok%5D=yes\"\n")),(0,r.kt)("h4",{id:"parameters-15"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Data to encode.")))),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Query string."),(0,r.kt)("h4",{id:"defined-in-42"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/url.ts#L129"},"packages/core/src/utils/url.ts:129")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"decodehtmlspeciachars"},"decodeHtmlSpeciaChars"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"decodeHtmlSpeciaChars"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"text"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Decodes HTML special chars entities"),(0,r.kt)("h4",{id:"parameters-16"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"text")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The text we want to decode")))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"text with decoded html entities"),(0,r.kt)("h4",{id:"defined-in-43"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/decodeHtmlSpeciaChars.ts#L8"},"packages/core/src/utils/decodeHtmlSpeciaChars.ts:8")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domtoreact"},"domToReact"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"domToReact"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"nodes"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element"),"[]"),(0,r.kt)("p",null,"Converts DOM nodes to JSX element(s)."),(0,r.kt)("h4",{id:"parameters-17"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"nodes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"DOM nodes.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"HTMLReactParserOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Parser options.")))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element"),"[]"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"JSX element(s).")),(0,r.kt)("h4",{id:"defined-in-44"},"Defined in"),(0,r.kt)("p",null,"node_modules/html-react-parser/lib/dom-to-react.d.ts:15"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchredirect"},"fetchRedirect"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchRedirect"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"pathname"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#redirectdata"},(0,r.kt)("inlineCode",{parentName:"a"},"RedirectData")),">"),(0,r.kt)("p",null,"Fetches a redirect from the WordPress origin by making a HEAD request and checking the response"),(0,r.kt)("h4",{id:"parameters-18"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pathname")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path to the page to fetch the redirect for")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The source url")))),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#redirectdata"},(0,r.kt)("inlineCode",{parentName:"a"},"RedirectData")),">"),(0,r.kt)("p",null,"The redirect data"),(0,r.kt)("h4",{id:"defined-in-45"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/fetchRedirect.ts#L51"},"packages/core/src/utils/fetchRedirect.ts:51")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAuthHeader"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"returns-19"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"defined-in-46"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/api/fetch-utils.ts#L3"},"packages/core/src/data/api/fetch-utils.ts:3")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcustomposttype"},"getCustomPostType"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCustomPostType"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"slug"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customposttype"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostType"))),(0,r.kt)("p",null,"Returns a single post type by slug if defined"),(0,r.kt)("h4",{id:"parameters-19"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"post type slug")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"})))),(0,r.kt)("h4",{id:"returns-20"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customposttype"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostType"))),(0,r.kt)("h4",{id:"defined-in-47"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/config.ts#L251"},"packages/core/src/utils/config.ts:251")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcustomposttypes"},"getCustomPostTypes"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCustomPostTypes"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customposttypes"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostTypes"))),(0,r.kt)("p",null,"Returns the available post types"),(0,r.kt)("h4",{id:"parameters-20"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-21"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customposttypes"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostTypes"))),(0,r.kt)("h4",{id:"defined-in-48"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/config.ts#L228"},"packages/core/src/utils/config.ts:228")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcustomposttypesslugs"},"getCustomPostTypesSlugs"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCustomPostTypesSlugs"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Returns the available post type slugs"),(0,r.kt)("h4",{id:"parameters-21"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-22"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("h4",{id:"defined-in-49"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/config.ts#L239"},"packages/core/src/utils/config.ts:239")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcustomtaxonomies"},"getCustomTaxonomies"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCustomTaxonomies"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customtaxonomies"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomies"))),(0,r.kt)("p",null,"Returns the available taxonomies"),(0,r.kt)("h4",{id:"parameters-22"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-23"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customtaxonomies"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomies"))),(0,r.kt)("h4",{id:"defined-in-50"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/config.ts#L188"},"packages/core/src/utils/config.ts:188")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcustomtaxonomy"},"getCustomTaxonomy"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCustomTaxonomy"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"slug"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customtaxonomy"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomy"))),(0,r.kt)("p",null,"Returns a single post type by slug if defined"),(0,r.kt)("h4",{id:"parameters-23"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"post type slug")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"})))),(0,r.kt)("h4",{id:"returns-24"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customtaxonomy"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomy"))),(0,r.kt)("h4",{id:"defined-in-51"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/config.ts#L217"},"packages/core/src/utils/config.ts:217")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcustomtaxonomyslugs"},"getCustomTaxonomySlugs"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCustomTaxonomySlugs"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Returns the available taxonomy slugs"),(0,r.kt)("h4",{id:"parameters-24"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-25"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("h4",{id:"defined-in-52"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/config.ts#L200"},"packages/core/src/utils/config.ts:200")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getheadlessconfig"},"getHeadlessConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getHeadlessConfig"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Returns the contents of headless.config.js"),(0,r.kt)("p",null,"This function requires framework integration in order to work. The contents of ",(0,r.kt)("inlineCode",{parentName:"p"},"headless.config.js"),"\nneeds to be injected at build time into a global variable."),(0,r.kt)("p",null,"Make sure you are using one of the framework's integration (such as next) before using this function."),(0,r.kt)("h4",{id:"returns-26"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The contents of headless.config.js"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customPostTypes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customposttypes"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostTypes")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customTaxonomies")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customtaxonomies"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomies")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"debug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"td"},"devMode?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"redirects?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"requests?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hostUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"integrations")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#integrations"},(0,r.kt)("inlineCode",{parentName:"a"},"Integrations")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"preview")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#previewconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewConfig")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"redirectStrategy")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#redirectstrategy"},(0,r.kt)("inlineCode",{parentName:"a"},"RedirectStrategy")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sites")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"useWordPressPlugin")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-53"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/config.ts#L22"},"packages/core/src/utils/config.ts:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getheadstartwpconfig"},"getHeadstartWPConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getHeadstartWPConfig"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Returns the contents of headless.config.js"),(0,r.kt)("p",null,"This function requires framework integration in order to work. The contents of ",(0,r.kt)("inlineCode",{parentName:"p"},"headless.config.js"),"\nneeds to be injected at build time into a global variable."),(0,r.kt)("p",null,"Make sure you are using one of the framework's integration (such as next) before using this function."),(0,r.kt)("h4",{id:"returns-27"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The contents of headless.config.js"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customPostTypes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customposttypes"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostTypes")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customTaxonomies")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customtaxonomies"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomies")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"debug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"td"},"devMode?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"redirects?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"requests?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hostUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"integrations")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#integrations"},(0,r.kt)("inlineCode",{parentName:"a"},"Integrations")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"preview")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#previewconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewConfig")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"redirectStrategy")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#redirectstrategy"},(0,r.kt)("inlineCode",{parentName:"a"},"RedirectStrategy")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sites")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"useWordPressPlugin")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-54"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/config.ts#L22"},"packages/core/src/utils/config.ts:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"gethosturl"},"getHostUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getHostUrl"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Returns the WP URL based on the headless config"),(0,r.kt)("h4",{id:"returns-28"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-55"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/config.ts#L268"},"packages/core/src/utils/config.ts:268")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getqueryargs"},"getQueryArgs"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getQueryArgs"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Returns an object of query arguments of the given URL. If the given URL is\ninvalid or has no querystring, an empty object is returned."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},'const foo = getQueryArgs( \'https://wordpress.org?foo=bar&bar=baz\' );\n// { "foo": "bar", "bar": "baz" }\n')),(0,r.kt)("h4",{id:"parameters-25"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"URL.")))),(0,r.kt)("h4",{id:"returns-29"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Query args object."),(0,r.kt)("h4",{id:"defined-in-56"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/url.ts#L78"},"packages/core/src/utils/url.ts:78")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getquerystring"},"getQueryString"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getQueryString"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h4",{id:"parameters-26"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-30"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h4",{id:"defined-in-57"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/url.ts#L49"},"packages/core/src/utils/url.ts:49")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsite"},"getSite"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSite"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("p",null,"Get a config for a specific site"),(0,r.kt)("h4",{id:"parameters-27"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h4",{id:"returns-31"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("h4",{id:"defined-in-58"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/config.ts#L113"},"packages/core/src/utils/config.ts:113")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsitebyhost"},"getSiteByHost"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSiteByHost"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"hostOrUrl"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"locale?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("p",null,"Finds a site by host and optionally locale"),(0,r.kt)("h4",{id:"parameters-28"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hostOrUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The hostname")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"locale?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"})))),(0,r.kt)("h4",{id:"returns-32"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("h4",{id:"defined-in-59"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/config.ts#L138"},"packages/core/src/utils/config.ts:138")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsitebysourceurl"},"getSiteBySourceUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSiteBySourceUrl"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("p",null,"Get a site by source url"),(0,r.kt)("h4",{id:"parameters-29"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-33"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("p",null,"HeadlessConfig"),(0,r.kt)("h4",{id:"defined-in-60"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/config.ts#L176"},"packages/core/src/utils/config.ts:176")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getwpurl"},"getWPUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getWPUrl"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Returns the WP URL based on the headless config"),(0,r.kt)("h4",{id:"returns-34"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-61"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/config.ts#L260"},"packages/core/src/utils/config.ts:260")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"htmltodom"},"htmlToDOM"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"htmlToDOM"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"html"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): (",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Comment"},(0,r.kt)("inlineCode",{parentName:"a"},"Comment"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.ProcessingInstruction"},(0,r.kt)("inlineCode",{parentName:"a"},"ProcessingInstruction"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Text"},(0,r.kt)("inlineCode",{parentName:"a"},"Text")),")[]"),(0,r.kt)("p",null,"Parses HTML string to DOM nodes in Node.js."),(0,r.kt)("p",null,"This is the same method as ",(0,r.kt)("inlineCode",{parentName:"p"},"require('htmlparser2').parseDOM"),"\n",(0,r.kt)("a",{parentName:"p",href:"https://github.com/fb55/htmlparser2/blob/v6.0.0/src/index.ts#L29-L41"},"https://github.com/fb55/htmlparser2/blob/v6.0.0/src/index.ts#L29-L41")),(0,r.kt)("h4",{id:"parameters-30"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"html")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"HTML markup.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"DomHandlerOptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Parser options (",(0,r.kt)("a",{parentName:"td",href:"https://github.com/fb55/domhandler/tree/v5.0.3#readme"},"https://github.com/fb55/domhandler/tree/v5.0.3#readme"),").")))),(0,r.kt)("h4",{id:"returns-35"},"Returns"),(0,r.kt)("p",null,"(",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Comment"},(0,r.kt)("inlineCode",{parentName:"a"},"Comment"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.ProcessingInstruction"},(0,r.kt)("inlineCode",{parentName:"a"},"ProcessingInstruction"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Text"},(0,r.kt)("inlineCode",{parentName:"a"},"Text")),")[]"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"DOM nodes.")),(0,r.kt)("h4",{id:"defined-in-62"},"Defined in"),(0,r.kt)("p",null,"node_modules/html-dom-parser/lib/server/html-to-dom.d.ts:21"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"iselement"},"isElement"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isElement"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): node is Element"),(0,r.kt)("p",null,"Checks if the node is an Element."),(0,r.kt)("p",null,"We rely on this function to avoid issues with instanceof."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/issues/504"},"https://github.com/10up/headstartwp/issues/504")),(0,r.kt)("h4",{id:"parameters-31"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The dom node")))),(0,r.kt)("h4",{id:"returns-36"},"Returns"),(0,r.kt)("p",null,"node is Element"),(0,r.kt)("p",null,"Whether the node is of type element or not"),(0,r.kt)("h4",{id:"defined-in-63"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/dom/index.ts#L25"},"packages/core/src/dom/index.ts:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isexternalurl"},"isExternalUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isExternalUrl"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"link"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Checks if the provided link is an external Url."),(0,r.kt)("p",null,"Inspired on the Frontity implementation"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/frontity/frontity/blob/dev/packages/components/link/utils.ts"},"https://github.com/frontity/frontity/blob/dev/packages/components/link/utils.ts")),(0,r.kt)("h4",{id:"parameters-32"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"link")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The link Url.")))),(0,r.kt)("h4",{id:"returns-37"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"True if the link is an external Url."),(0,r.kt)("h4",{id:"defined-in-64"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/isExternalUrl.ts#L12"},"packages/core/src/utils/isExternalUrl.ts:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isinternallink"},"isInternalLink"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isInternalLink"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Checks if the url is for an internal link"),(0,r.kt)("h4",{id:"parameters-33"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The url to check")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"(optional) the site config")))),(0,r.kt)("h4",{id:"returns-38"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-65"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/isInternalLink.ts#L14"},"packages/core/src/utils/isInternalLink.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"log"},"log"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"log"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"type"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"...args"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-34"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"type")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/headstartwp_core.LOGTYPE"},(0,r.kt)("inlineCode",{parentName:"a"},"LOGTYPE")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"...args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"),"[]")))),(0,r.kt)("h4",{id:"returns-39"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-66"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/log.ts#L9"},"packages/core/src/utils/log.ts:9")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removefieldsfrompostrelateddata"},"removeFieldsFromPostRelatedData"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeFieldsFromPostRelatedData"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fieldsToRemove"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"post"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"p"},"_embedded"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"author"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"wp:featuredmedia"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"wp:term"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]"," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"author?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"categories?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"comment_status?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"closed"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"content"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"date"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"date_gmt"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"excerpt"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"featured_media"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"format"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"link"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"status"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"standard"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"aside"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"chat"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"gallery"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"image"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"quote"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"video"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"audio"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"guid"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"link"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"modified"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"modified_gmt"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"ping_status"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"closed"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"status"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"publish"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"future"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"draft"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"pending"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"private"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"sticky"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"tags?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"template"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"terms?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"title"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"yoast_head?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"yoast_head_json?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"," }"),(0,r.kt)("h4",{id:"parameters-35"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fieldsToRemove")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"number"),")[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"post")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity")))))),(0,r.kt)("h4",{id:"returns-40"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"p"},"_embedded"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"author"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"wp:featuredmedia"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"wp:term"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]"," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"author?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"categories?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"comment_status?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"closed"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"content"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"date"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"date_gmt"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"excerpt"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"featured_media"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"format"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"link"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"status"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"standard"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"aside"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"chat"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"gallery"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"image"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"quote"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"video"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"audio"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"guid"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"link"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"modified"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"modified_gmt"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"ping_status"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"closed"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"status"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"publish"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"future"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"draft"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"pending"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"private"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"sticky"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"tags?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"template"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"terms?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"title"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"yoast_head?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"yoast_head_json?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"," }"),(0,r.kt)("h4",{id:"defined-in-67"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/utils/postHandling.ts#L51"},"packages/core/src/data/utils/postHandling.ts:51")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removesourceurl"},"removeSourceUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeSourceUrl"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Make the link relative if it belongs to the backend, to force client-side\nnavigation."),(0,r.kt)("p",null,"Inspired on the Frontity implementation"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/frontity/frontity/blob/dev/packages/components/link/utils.ts"},"https://github.com/frontity/frontity/blob/dev/packages/components/link/utils.ts")),(0,r.kt)("h4",{id:"parameters-36"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#removesourceurltype"},(0,r.kt)("inlineCode",{parentName:"a"},"removeSourceUrlType")))))),(0,r.kt)("h4",{id:"returns-41"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The URL without the Source URL."),(0,r.kt)("h4",{id:"defined-in-68"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/removeSourceUrl.ts#L42"},"packages/core/src/utils/removeSourceUrl.ts:42")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setheadlessconfig"},"setHeadlessConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setHeadlessConfig"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"config"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-37"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"config")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h4",{id:"returns-42"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-69"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/config.ts#L6"},"packages/core/src/utils/config.ts:6")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setheadstartwpconfig"},"setHeadstartWPConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setHeadstartWPConfig"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"config"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-38"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"config")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h4",{id:"returns-43"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-70"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/config.ts#L6"},"packages/core/src/utils/config.ts:6")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"striptags"},"stripTags"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"stripTags"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"html"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("p",null,"Utility functions to strip any tags"),(0,r.kt)("h4",{id:"parameters-39"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"html")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The html string")))),(0,r.kt)("h4",{id:"returns-44"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h4",{id:"defined-in-71"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/dom/stripTags.ts#L8"},"packages/core/src/dom/stripTags.ts:8")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"warn"},"warn"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"warn"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"message"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Logs a warning in the console in dev mode"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},'warn("You should do/change something.")\n')),(0,r.kt)("h4",{id:"parameters-40"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"message")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The message that describes the warning.")))),(0,r.kt)("h4",{id:"returns-45"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-72"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/errors.ts#L45"},"packages/core/src/utils/errors.ts:45")),(0,r.kt)("h2",{id:"utility-functions"},"Utility Functions"),(0,r.kt)("h3",{id:"parsepath"},"parsePath"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"parsePath"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"matchers"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Parses a path and extracts the parameters from it"),(0,r.kt)("h4",{id:"parameters-41"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"matchers")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#matcher"},(0,r.kt)("inlineCode",{parentName:"a"},"Matcher")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"An array of Matchers")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path")))),(0,r.kt)("h4",{id:"returns-46"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"the extracted parameters"),(0,r.kt)("h4",{id:"defined-in-73"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/utils/parsePath.ts#L46"},"packages/core/src/data/utils/parsePath.ts:46")))}m.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2925],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>u});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var d=n.createContext({}),o=function(e){var t=n.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},s=function(e){var t=o(e.components);return n.createElement(d.Provider,{value:t},e.children)},m="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},N=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,s=p(e,["components","mdxType","originalType","parentName"]),m=o(a),N=r,u=m["".concat(d,".").concat(N)]||m[N]||k[N]||i;return a?n.createElement(u,l(l({ref:t},s),{},{components:a})):n.createElement(u,l({ref:t},s))}));function u(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,l=new Array(i);l[0]=N;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p[m]="string"==typeof e?e:r,l[1]=p;for(var o=2;o{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>m,frontMatter:()=>i,metadata:()=>p,toc:()=>o});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core",title:"Module: @headstartwp/core",sidebar_label:"@headstartwp/core",sidebar_position:0,custom_edit_url:null},l=void 0,p={unversionedId:"modules/headstartwp_core",id:"modules/headstartwp_core",title:"Module: @headstartwp/core",description:"Namespaces",source:"@site/docs/modules/headstartwp_core.md",sourceDirName:"modules",slug:"/modules/headstartwp_core",permalink:"/docs/api/modules/headstartwp_core",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"headstartwp_core",title:"Module: @headstartwp/core",sidebar_label:"@headstartwp/core",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"Table of Contents",permalink:"/docs/api/"},next:{title:"@headstartwp/next",permalink:"/docs/api/modules/headstartwp_next"}},d={},o=[{value:"Namespaces",id:"namespaces",level:2},{value:"Enumerations",id:"enumerations",level:2},{value:"Classes",id:"classes",level:2},{value:"Interfaces",id:"interfaces",level:2},{value:"DOM Helpers",id:"dom-helpers",level:2},{value:"isAnchorTag",id:"isanchortag",level:3},{value:"Usage",id:"usage",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"isBlock",id:"isblock",level:3},{value:"Usage",id:"usage-1",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isBlockByName",id:"isblockbyname",level:3},{value:"Usage",id:"usage-2",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"isImageTag",id:"isimagetag",level:3},{value:"Usage",id:"usage-3",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"isTwitterEmbed",id:"istwitterembed",level:3},{value:"Usage",id:"usage-4",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"isYoutubeEmbed",id:"isyoutubeembed",level:3},{value:"Usage",id:"usage-5",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"wpKsesPost",id:"wpksespost",level:3},{value:"Usage",id:"usage-6",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Data Fetching",id:"data-fetching",level:2},{value:"apiGet",id:"apiget",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"apiPost",id:"apipost",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"Data Handling",id:"data-handling",level:2},{value:"getPostAuthor",id:"getpostauthor",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getPostTerms",id:"getpostterms",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"Other",id:"other",level:2},{value:"CustomPostType",id:"customposttype",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"CustomPostTypes",id:"customposttypes",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"CustomTaxonomies",id:"customtaxonomies",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"CustomTaxonomy",id:"customtaxonomy",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"DOMNode",id:"domnode",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"HTMLParser2Options",id:"htmlparser2options",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"HeadlessConfig",id:"headlessconfig",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"Integrations",id:"integrations",level:3},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"Matcher",id:"matcher",level:3},{value:"Type declaration",id:"type-declaration-4",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"NormalizedDataForCache",id:"normalizeddataforcache",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Type declaration",id:"type-declaration-5",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"PostOrPostsFetchStrategyResult",id:"postorpostsfetchstrategyresult",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Type declaration",id:"type-declaration-6",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"PreviewConfig",id:"previewconfig",level:3},{value:"Type declaration",id:"type-declaration-7",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"QueriedObject",id:"queriedobject",level:3},{value:"Type declaration",id:"type-declaration-8",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"Redirect",id:"redirect",level:3},{value:"Type declaration",id:"type-declaration-9",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"RedirectData",id:"redirectdata",level:3},{value:"Type declaration",id:"type-declaration-10",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"RedirectStrategy",id:"redirectstrategy",level:3},{value:"Defined in",id:"defined-in-26",level:4},{value:"isAnchorTagOptions",id:"isanchortagoptions",level:3},{value:"Type declaration",id:"type-declaration-11",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"isBlockOptions",id:"isblockoptions",level:3},{value:"Type declaration",id:"type-declaration-12",level:4},{value:"Defined in",id:"defined-in-28",level:4},{value:"isImageTagOptions",id:"isimagetagoptions",level:3},{value:"Type declaration",id:"type-declaration-13",level:4},{value:"Defined in",id:"defined-in-29",level:4},{value:"removeSourceUrlType",id:"removesourceurltype",level:3},{value:"Type declaration",id:"type-declaration-14",level:4},{value:"Defined in",id:"defined-in-30",level:4},{value:"authorArchivesMatchers",id:"authorarchivesmatchers",level:3},{value:"Defined in",id:"defined-in-31",level:4},{value:"endpoints",id:"endpoints",level:3},{value:"Type declaration",id:"type-declaration-15",level:4},{value:"Defined in",id:"defined-in-32",level:4},{value:"ksesAllowedList",id:"ksesallowedlist",level:3},{value:"Defined in",id:"defined-in-33",level:4},{value:"postMatchers",id:"postmatchers",level:3},{value:"Defined in",id:"defined-in-34",level:4},{value:"postsMatchers",id:"postsmatchers",level:3},{value:"Defined in",id:"defined-in-35",level:4},{value:"searchMatchers",id:"searchmatchers",level:3},{value:"Defined in",id:"defined-in-36",level:4},{value:"youtubeEmbedRegex",id:"youtubeembedregex",level:3},{value:"Defined in",id:"defined-in-37",level:4},{value:"HTMLReactParser",id:"htmlreactparser",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-38",level:4},{value:"addQueryArgs",id:"addqueryargs",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-39",level:4},{value:"asyncForEach",id:"asyncforeach",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-40",level:4},{value:"attributesToProps",id:"attributestoprops",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-41",level:4},{value:"buildQueryString",id:"buildquerystring",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-42",level:4},{value:"decodeHtmlSpeciaChars",id:"decodehtmlspeciachars",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-43",level:4},{value:"domToReact",id:"domtoreact",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-44",level:4},{value:"fetchRedirect",id:"fetchredirect",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Defined in",id:"defined-in-45",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Returns",id:"returns-19",level:4},{value:"Defined in",id:"defined-in-46",level:4},{value:"getCustomPostType",id:"getcustomposttype",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-20",level:4},{value:"Defined in",id:"defined-in-47",level:4},{value:"getCustomPostTypes",id:"getcustomposttypes",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-21",level:4},{value:"Defined in",id:"defined-in-48",level:4},{value:"getCustomPostTypesSlugs",id:"getcustomposttypesslugs",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-22",level:4},{value:"Defined in",id:"defined-in-49",level:4},{value:"getCustomTaxonomies",id:"getcustomtaxonomies",level:3},{value:"Parameters",id:"parameters-22",level:4},{value:"Returns",id:"returns-23",level:4},{value:"Defined in",id:"defined-in-50",level:4},{value:"getCustomTaxonomy",id:"getcustomtaxonomy",level:3},{value:"Parameters",id:"parameters-23",level:4},{value:"Returns",id:"returns-24",level:4},{value:"Defined in",id:"defined-in-51",level:4},{value:"getCustomTaxonomySlugs",id:"getcustomtaxonomyslugs",level:3},{value:"Parameters",id:"parameters-24",level:4},{value:"Returns",id:"returns-25",level:4},{value:"Defined in",id:"defined-in-52",level:4},{value:"getHeadlessConfig",id:"getheadlessconfig",level:3},{value:"Returns",id:"returns-26",level:4},{value:"Defined in",id:"defined-in-53",level:4},{value:"getHeadstartWPConfig",id:"getheadstartwpconfig",level:3},{value:"Returns",id:"returns-27",level:4},{value:"Defined in",id:"defined-in-54",level:4},{value:"getHostUrl",id:"gethosturl",level:3},{value:"Returns",id:"returns-28",level:4},{value:"Defined in",id:"defined-in-55",level:4},{value:"getQueryArgs",id:"getqueryargs",level:3},{value:"Parameters",id:"parameters-25",level:4},{value:"Returns",id:"returns-29",level:4},{value:"Defined in",id:"defined-in-56",level:4},{value:"getQueryString",id:"getquerystring",level:3},{value:"Parameters",id:"parameters-26",level:4},{value:"Returns",id:"returns-30",level:4},{value:"Defined in",id:"defined-in-57",level:4},{value:"getSite",id:"getsite",level:3},{value:"Parameters",id:"parameters-27",level:4},{value:"Returns",id:"returns-31",level:4},{value:"Defined in",id:"defined-in-58",level:4},{value:"getSiteByHost",id:"getsitebyhost",level:3},{value:"Parameters",id:"parameters-28",level:4},{value:"Returns",id:"returns-32",level:4},{value:"Defined in",id:"defined-in-59",level:4},{value:"getSiteBySourceUrl",id:"getsitebysourceurl",level:3},{value:"Parameters",id:"parameters-29",level:4},{value:"Returns",id:"returns-33",level:4},{value:"Defined in",id:"defined-in-60",level:4},{value:"getWPUrl",id:"getwpurl",level:3},{value:"Returns",id:"returns-34",level:4},{value:"Defined in",id:"defined-in-61",level:4},{value:"htmlToDOM",id:"htmltodom",level:3},{value:"Parameters",id:"parameters-30",level:4},{value:"Returns",id:"returns-35",level:4},{value:"Defined in",id:"defined-in-62",level:4},{value:"isElement",id:"iselement",level:3},{value:"Parameters",id:"parameters-31",level:4},{value:"Returns",id:"returns-36",level:4},{value:"Defined in",id:"defined-in-63",level:4},{value:"isExternalUrl",id:"isexternalurl",level:3},{value:"Parameters",id:"parameters-32",level:4},{value:"Returns",id:"returns-37",level:4},{value:"Defined in",id:"defined-in-64",level:4},{value:"isInternalLink",id:"isinternallink",level:3},{value:"Parameters",id:"parameters-33",level:4},{value:"Returns",id:"returns-38",level:4},{value:"Defined in",id:"defined-in-65",level:4},{value:"log",id:"log",level:3},{value:"Parameters",id:"parameters-34",level:4},{value:"Returns",id:"returns-39",level:4},{value:"Defined in",id:"defined-in-66",level:4},{value:"removeFieldsFromPostRelatedData",id:"removefieldsfrompostrelateddata",level:3},{value:"Parameters",id:"parameters-35",level:4},{value:"Returns",id:"returns-40",level:4},{value:"Defined in",id:"defined-in-67",level:4},{value:"removeSourceUrl",id:"removesourceurl",level:3},{value:"Parameters",id:"parameters-36",level:4},{value:"Returns",id:"returns-41",level:4},{value:"Defined in",id:"defined-in-68",level:4},{value:"setHeadlessConfig",id:"setheadlessconfig",level:3},{value:"Parameters",id:"parameters-37",level:4},{value:"Returns",id:"returns-42",level:4},{value:"Defined in",id:"defined-in-69",level:4},{value:"setHeadstartWPConfig",id:"setheadstartwpconfig",level:3},{value:"Parameters",id:"parameters-38",level:4},{value:"Returns",id:"returns-43",level:4},{value:"Defined in",id:"defined-in-70",level:4},{value:"stripTags",id:"striptags",level:3},{value:"Parameters",id:"parameters-39",level:4},{value:"Returns",id:"returns-44",level:4},{value:"Defined in",id:"defined-in-71",level:4},{value:"warn",id:"warn",level:3},{value:"Parameters",id:"parameters-40",level:4},{value:"Returns",id:"returns-45",level:4},{value:"Defined in",id:"defined-in-72",level:4},{value:"Utility Functions",id:"utility-functions",level:2},{value:"parsePath",id:"parsepath",level:3},{value:"Parameters",id:"parameters-41",level:4},{value:"Returns",id:"returns-46",level:4},{value:"Defined in",id:"defined-in-73",level:4}],s={toc:o};function m(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"namespaces"},"Namespaces"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/namespaces/headstartwp_core.react"},"react"))),(0,r.kt)("h2",{id:"enumerations"},"Enumerations"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/enums/headstartwp_core.LOGTYPE"},"LOGTYPE"))),(0,r.kt)("h2",{id:"classes"},"Classes"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.AppSettingsStrategy"},"AppSettingsStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy"},"AuthorArchiveFetchStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.Comment"},"Comment")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.ConfigError"},"ConfigError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.Element"},"Element")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.EndpointError"},"EndpointError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.FetchError"},"FetchError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.FrameworkError"},"FrameworkError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.NotFoundError"},"NotFoundError")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy"},"PostOrPostsFetchStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.ProcessingInstruction"},"ProcessingInstruction")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.SearchFetchStrategy"},"SearchFetchStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.SearchNativeFetchStrategy"},"SearchNativeFetchStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy"},"SinglePostFetchStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy"},"TaxonomyTermsStrategy")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.Text"},"Text")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy"},"VerifyTokenFetchStrategy"))),(0,r.kt)("h2",{id:"interfaces"},"Interfaces"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},"AppEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.AttachmentEntity"},"AttachmentEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},"AuthorEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.AvatarUrls"},"AvatarUrls")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.CommentEntity"},"CommentEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},"FetchOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},"FetchResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},"FilterDataOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions"},"HTMLReactParserOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.Integration"},"Integration")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"},"MenuItemEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PageEntity"},"PageEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},"PageInfo")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PolylangIntegration"},"PolylangIntegration")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},"PostEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},"PostOrPostsParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PostParams"},"PostParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"},"PostSearchEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},"PostsArchiveParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.Rendered"},"Rendered")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.RevisionEntity"},"RevisionEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.SearchEntity"},"SearchEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},"SearchObjectEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.SearchParams"},"SearchParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},"TaxonomyArchiveParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.TaxonomyEntity"},"TaxonomyEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},"TermEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.TermSearchEntity"},"TermSearchEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.TypeEntity"},"TypeEntity")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams"},"VerifyTokenParams")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.YoastSEOIntegration"},"YoastSEOIntegration"))),(0,r.kt)("h2",{id:"dom-helpers"},"DOM Helpers"),(0,r.kt)("h3",{id:"isanchortag"},"isAnchorTag"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isAnchorTag"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): node is Element"),(0,r.kt)("p",null,"Checks if the provided node is an valid anchor tag"),(0,r.kt)("p",null,"This function expects to be used with ",(0,r.kt)("inlineCode",{parentName:"p"},"DOMNode")," objects from ",(0,r.kt)("inlineCode",{parentName:"p"},"html-react-parser"),", which is\nthe underlying parser used by BlocksRenderer."),(0,r.kt)("h4",{id:"usage"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { isAnchorTag } from '@headstartwp/core';\nimport { LinkBlock } from '@10up/headless-next';\n\n\n isAnchorTag(node, { isInternalLink: true})} />\n\n")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The node to test")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#isanchortagoptions"},(0,r.kt)("inlineCode",{parentName:"a"},"isAnchorTagOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Supported options")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"})))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,"node is Element"),(0,r.kt)("p",null,"Whether it's an anchor tag according to the options passed"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/dom/index.ts#L77"},"packages/core/src/dom/index.ts:77")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isblock"},"isBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"_options"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Tests a node by tagName and/or className"),(0,r.kt)("p",null,"This function expects to be used with ",(0,r.kt)("inlineCode",{parentName:"p"},"DOMNode")," objects from ",(0,r.kt)("inlineCode",{parentName:"p"},"html-react-parser"),", which is\nthe underlying parser used by BlocksRenderer."),(0,r.kt)("h4",{id:"usage-1"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { isBlock } from '@headstartwp/core';\n\n\n isBlock(node, { tagName: 'div', classList: ['block-class-name'] })}\n />\n\n")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The node to test")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"_options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#isblockoptions"},(0,r.kt)("inlineCode",{parentName:"a"},"isBlockOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"})))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"true if the node passes the test"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/dom/index.ts#L278"},"packages/core/src/dom/index.ts:278")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isblockbyname"},"isBlockByName"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isBlockByName"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"name"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Tests a node by block name. This requires the Headless WP Plugin to be installed."),(0,r.kt)("p",null,"The Headless WP Plugin will append ",(0,r.kt)("inlineCode",{parentName:"p"},"data-wp-block-name")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"data-wp-block")," to every block,\nthis function relies on those attributes to determine if the node is a block."),(0,r.kt)("p",null,"This function expects to be used with ",(0,r.kt)("inlineCode",{parentName:"p"},"DOMNode")," objects from ",(0,r.kt)("inlineCode",{parentName:"p"},"html-react-parser"),", which is\nthe underlying parser used by BlocksRenderer."),(0,r.kt)("h4",{id:"usage-2"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { isBlockByName } from '@headstartwp/core';\n\n\n isBlock(node, 'core/paragraph')}\n />\n\n")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The node to test")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The block name")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"true if the node passes the test"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/dom/index.ts#L334"},"packages/core/src/dom/index.ts:334")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isimagetag"},"isImageTag"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isImageTag"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Checks if the provided node is an valid image tag"),(0,r.kt)("p",null,"This function expects to be used with ",(0,r.kt)("inlineCode",{parentName:"p"},"DOMNode")," objects from ",(0,r.kt)("inlineCode",{parentName:"p"},"html-react-parser"),", which is\nthe underlying parser used by BlocksRenderer."),(0,r.kt)("h4",{id:"usage-3"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { isImageTag, ImageBlock } from '@headstartwp/core';\nimport { ImageComponent } from '@10up/headless-next';\n\n\n isImageTag(node, { hasDimensions: true})}\n component={ImageComponent}\n />\n\n")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The node to test")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#isimagetagoptions"},(0,r.kt)("inlineCode",{parentName:"a"},"isImageTagOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Supported options.")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Whether it's an image tag or not according to the options passed"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/dom/index.ts#L141"},"packages/core/src/dom/index.ts:141")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"istwitterembed"},"isTwitterEmbed"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isTwitterEmbed"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Checks if the node is an twitter embed"),(0,r.kt)("p",null,"This function expects to be used with ",(0,r.kt)("inlineCode",{parentName:"p"},"DOMNode")," objects from ",(0,r.kt)("inlineCode",{parentName:"p"},"html-react-parser"),", which is\nthe underlying parser used by BlocksRenderer."),(0,r.kt)("h4",{id:"usage-4"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { isTwitterEmbed } from '@headstartwp/core';\n\n\n \n\n")),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The node to test")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"true if the node is a twitter embed"),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/dom/index.ts#L227"},"packages/core/src/dom/index.ts:227")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isyoutubeembed"},"isYoutubeEmbed"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isYoutubeEmbed"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Checks if the node is an youtube embed"),(0,r.kt)("p",null,"This function expects to be used with ",(0,r.kt)("inlineCode",{parentName:"p"},"DOMNode")," objects from ",(0,r.kt)("inlineCode",{parentName:"p"},"html-react-parser"),", which is\nthe underlying parser used by BlocksRenderer."),(0,r.kt)("h4",{id:"usage-5"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { isYoutubeEmbed } from '@headstartwp/core';\n\n\n \n\n")),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The node to test")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"true if the node is a youtube embed"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/dom/index.ts#L187"},"packages/core/src/dom/index.ts:187")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"wpksespost"},"wpKsesPost"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"wpKsesPost"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"content"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"allowList?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Sanitize HTML content by the wp_kses_post() requirements"),(0,r.kt)("h4",{id:"usage-6"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { wpKsesPost } from '@headstartwp/core';\nwpKsesPost(html);\n")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://codex.wordpress.org/Function_Reference/wp_kses_post"},"https://codex.wordpress.org/Function_Reference/wp_kses_post")),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"content")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The content to sanitize.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"allowList?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"IWhiteList")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Optional. The list of allowed HTML tags and attributes. If not set, the default allow list will be used.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"IWpKsesPostOptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Optional. IWpKsesPostOptions.")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Sanitized string of HTML."),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/dom/wpKsesPost.ts#L30"},"packages/core/src/dom/wpKsesPost.ts:30")),(0,r.kt)("h2",{id:"data-fetching"},"Data Fetching"),(0,r.kt)("h3",{id:"apiget"},"apiGet"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"apiGet"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"args?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"burstCache?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"headers"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"[index: string]"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),"; } = receivedHeaders; ",(0,r.kt)("inlineCode",{parentName:"p"},"json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," }",">"),(0,r.kt)("p",null,"Fetch Wrapper to handle GET requests."),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The URL where to make the request to")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The arguments")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"burstCache")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"false")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Whether it should burst cache")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"headers"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"[index: string]"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),"; } = receivedHeaders; ",(0,r.kt)("inlineCode",{parentName:"p"},"json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," }",">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/api/fetch-utils.ts#L46"},"packages/core/src/data/api/fetch-utils.ts:46")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"apipost"},"apiPost"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"apiPost"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"args?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Fetch Wrapper to handle POST requests"),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The URL where to make the request to")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The arguments")))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/api/fetch-utils.ts#L17"},"packages/core/src/data/api/fetch-utils.ts:17")),(0,r.kt)("h2",{id:"data-handling"},"Data Handling"),(0,r.kt)("h3",{id:"getpostauthor"},"getPostAuthor"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getPostAuthor"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"post"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,r.kt)("p",null,"Returns the author object from the post object if it exists"),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"post")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostSearchEntity"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The Post object")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/utils/postHandling.ts#L11"},"packages/core/src/data/utils/postHandling.ts:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getpostterms"},"getPostTerms"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getPostTerms"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"post"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,r.kt)("p",null,"Returns the terms associated with the post"),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"post")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostSearchEntity"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The Post object")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/utils/postHandling.ts#L22"},"packages/core/src/data/utils/postHandling.ts:22")),(0,r.kt)("h2",{id:"other"},"Other"),(0,r.kt)("h3",{id:"customposttype"},"CustomPostType"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"CustomPostType"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"archive?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"matchSinglePath?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Whether this custom post type should match the archive path If set to true, then when querying a post type archive page such as ",(0,r.kt)("inlineCode",{parentName:"td"},"/[post-type]/[post-name]")," the ",(0,r.kt)("inlineCode",{parentName:"td"},"post.link")," property should match the current path. This will avoid matching nested posts/pages that doesn't exist for instance: ",(0,r.kt)("inlineCode",{parentName:"td"},"/[post-type]/fake-parent-page/[post-name]")," will not match if this option is set to true even though ",(0,r.kt)("inlineCode",{parentName:"td"},"post-name")," exists. It is strongly recommended to set this option to true, otherwise hierarchical post types (such as pages) will not work properly. ",(0,r.kt)("strong",{parentName:"td"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))," true")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"single?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/types.ts#L1"},"packages/core/src/types.ts:1")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"customposttypes"},"CustomPostTypes"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"CustomPostTypes"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customposttype"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostType")),"[]"),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/types.ts#L21"},"packages/core/src/types.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"customtaxonomies"},"CustomTaxonomies"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"CustomTaxonomies"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customtaxonomy"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomy")),"[]"),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/types.ts#L43"},"packages/core/src/types.ts:43")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"customtaxonomy"},"CustomTaxonomy"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"CustomTaxonomy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"matchArchivePath?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Whether this custom taxonomy should match the archive path If set to true, then when querying a taxonomy archive page such as ",(0,r.kt)("inlineCode",{parentName:"td"},"/[taxonmy-slug]/[term-slug]")," the ",(0,r.kt)("inlineCode",{parentName:"td"},"term.link")," property should match the current path. This will avoid matching nested categories that doesn't exist for instance: ",(0,r.kt)("inlineCode",{parentName:"td"},"/[taxonmy-slug]/fake-parent-term/[term-slug]")," will not match if this option is set to true even though ",(0,r.kt)("inlineCode",{parentName:"td"},"term-slug")," exists. ",(0,r.kt)("strong",{parentName:"td"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))," false")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"restParam?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"rewrite?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/types.ts#L25"},"packages/core/src/types.ts:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domnode"},"DOMNode"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"DOMNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Comment"},(0,r.kt)("inlineCode",{parentName:"a"},"Comment"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Node")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.ProcessingInstruction"},(0,r.kt)("inlineCode",{parentName:"a"},"ProcessingInstruction"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Text"},(0,r.kt)("inlineCode",{parentName:"a"},"Text"))),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,"node_modules/html-react-parser/index.d.ts:21"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"htmlparser2options"},"HTMLParser2Options"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HTMLParser2Options"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ParserOptions")," & ",(0,r.kt)("inlineCode",{parentName:"p"},"DomHandlerOptions")),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,"node_modules/html-react-parser/index.d.ts:19"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"headlessconfig"},"HeadlessConfig"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HeadlessConfig"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customPostTypes?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customposttypes"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostTypes"))," ","|"," (",(0,r.kt)("inlineCode",{parentName:"td"},"defaultPostTypes"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customposttypes"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostTypes")),") => ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customposttypes"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostTypes")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customTaxonomies?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customtaxonomies"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomies"))," ","|"," (",(0,r.kt)("inlineCode",{parentName:"td"},"defaultTaxonomies"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customtaxonomies"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomies")),") => ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customtaxonomies"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomies")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"debug?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"devMode?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"redirects?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"requests?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"debug.devMode?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"debug.redirects?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"debug.requests?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"host?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hostUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"integrations?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#integrations"},(0,r.kt)("inlineCode",{parentName:"a"},"Integrations")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"locale?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"preview?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#previewconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewConfig")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"redirectStrategy?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#redirectstrategy"},(0,r.kt)("inlineCode",{parentName:"a"},"RedirectStrategy")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sites?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"useWordPressPlugin?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/types.ts#L73"},"packages/core/src/types.ts:73")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"integrations"},"Integrations"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Integrations"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"polylang?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PolylangIntegration"},(0,r.kt)("inlineCode",{parentName:"a"},"PolylangIntegration")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"yoastSEO?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.YoastSEOIntegration"},(0,r.kt)("inlineCode",{parentName:"a"},"YoastSEOIntegration")))))),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/types.ts#L53"},"packages/core/src/types.ts:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"matcher"},"Matcher"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Matcher"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-4"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pattern")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"priority")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/utils/matchers.ts#L1"},"packages/core/src/data/utils/matchers.ts:1")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"normalizeddataforcache"},"NormalizedDataForCache"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"NormalizedDataForCache"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P"))))),(0,r.kt)("h4",{id:"type-declaration-5"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"additionalCacheObjects?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,r.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">","[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"url"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key.args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key.url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L97"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:97")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"postorpostsfetchstrategyresult"},"PostOrPostsFetchStrategyResult"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"PostOrPostsFetchStrategyResult"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))))),(0,r.kt)("h4",{id:"type-declaration-6"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isArchive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isSingle")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L42"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:42")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"previewconfig"},"PreviewConfig"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"PreviewConfig"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-7"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"alternativeAuthorizationHeader?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Flag to enable using the alternative authorization header. This can be useful if you have separate JWT-based authentication on your project.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"usePostLinkForRedirect?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If enabled, it will use the ",(0,r.kt)("inlineCode",{parentName:"td"},"post.link")," property of the REST response to redirect to the appropriate route for previewing")))),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/types.ts#L58"},"packages/core/src/types.ts:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"queriedobject"},"QueriedObject"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"QueriedObject"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The QueriedObject represents the object that the current requests is subjected to."),(0,r.kt)("p",null,"Querying by taxonomy and/or author will set the queried object."),(0,r.kt)("h4",{id:"type-declaration-8"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"author?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"If the request is an author query, this will be populated with the author object")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"search?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.SearchEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"SearchEntity"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"If the request is a search query, this will be populated with the search entity object")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"term?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"If the request is a term query, this will be populated with the term object")))),(0,r.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L765"},"packages/core/src/data/types/entities.ts:765")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"redirect"},"Redirect"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Redirect"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-9"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ID")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"enable_regex")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"post_status")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"redirect_from")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"redirect_to")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"status_code")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))))),(0,r.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L705"},"packages/core/src/data/types/entities.ts:705")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"redirectdata"},"RedirectData"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"RedirectData"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-10"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"location")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"null")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The redirect new location will be null if no redirect is found")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"status")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The status number of the redirect Will be 0 if the redirect is not found")))),(0,r.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/fetchRedirect.ts#L5"},"packages/core/src/utils/fetchRedirect.ts:5")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"redirectstrategy"},"RedirectStrategy"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"RedirectStrategy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"404"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"none"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"always"')),(0,r.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/types.ts#L23"},"packages/core/src/types.ts:23")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isanchortagoptions"},"isAnchorTagOptions"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"isAnchorTagOptions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-11"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isInternalLink?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},'If true, will check if the anchor tag contains a valid internal link. if target="_blank" then this option is not taken into account')))),(0,r.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/dom/index.ts#L5"},"packages/core/src/dom/index.ts:5")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isblockoptions"},"isBlockOptions"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"isBlockOptions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-12"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"className?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"A single or array of classNames to check for If an array of class names is passed, the block will be considered valid if all of the class names are found")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tagName?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The tagName to check for")))),(0,r.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/dom/index.ts#L238"},"packages/core/src/dom/index.ts:238")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isimagetagoptions"},"isImageTagOptions"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"isImageTagOptions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-13"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hasDimensions?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If true, will check if the image tag contains width and height attributes")))),(0,r.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/dom/index.ts#L107"},"packages/core/src/dom/index.ts:107")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removesourceurltype"},"removeSourceUrlType"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"removeSourceUrlType"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-14"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"backendUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The backend url.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"link")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The link url, possibly with the source url.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"nonEmptyLink?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If the removal of source url from link leads to a empty string, this setting control whether a '/' should be returned or the empty string")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"publicUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The public url. Defaults to '/'.")))),(0,r.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/removeSourceUrl.ts#L3"},"packages/core/src/utils/removeSourceUrl.ts:3")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"authorarchivesmatchers"},"authorArchivesMatchers"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"authorArchivesMatchers"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#matcher"},(0,r.kt)("inlineCode",{parentName:"a"},"Matcher")),"[]"),(0,r.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/utils/matchers.ts#L43"},"packages/core/src/data/utils/matchers.ts:43")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"endpoints"},"endpoints"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"endpoints"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-15"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"appSettings")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"category")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pages")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"posts")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"search")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tags")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"tokenVerify")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"yoast")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/endpoints.ts#L1"},"packages/core/src/utils/endpoints.ts:1")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"ksesallowedlist"},"ksesAllowedList"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"ksesAllowedList"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"IWhiteList")),(0,r.kt)("p",null,"Default Allowed HTML Attributes"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://codex.wordpress.org/Function_Reference/wp_kses_post"},"https://codex.wordpress.org/Function_Reference/wp_kses_post")),(0,r.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/dom/wpKsesPost.ts#L266"},"packages/core/src/dom/wpKsesPost.ts:266")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"postmatchers"},"postMatchers"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"postMatchers"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#matcher"},(0,r.kt)("inlineCode",{parentName:"a"},"Matcher")),"[]"),(0,r.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/utils/matchers.ts#L7"},"packages/core/src/data/utils/matchers.ts:7")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"postsmatchers"},"postsMatchers"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"postsMatchers"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#matcher"},(0,r.kt)("inlineCode",{parentName:"a"},"Matcher")),"[]"),(0,r.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/utils/matchers.ts#L20"},"packages/core/src/data/utils/matchers.ts:20")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"searchmatchers"},"searchMatchers"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"searchMatchers"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#matcher"},(0,r.kt)("inlineCode",{parentName:"a"},"Matcher")),"[]"),(0,r.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/utils/matchers.ts#L56"},"packages/core/src/data/utils/matchers.ts:56")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"youtubeembedregex"},"youtubeEmbedRegex"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"youtubeEmbedRegex"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"RegExp")),(0,r.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/dom/index.ts#L160"},"packages/core/src/dom/index.ts:160")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"htmlreactparser"},"HTMLReactParser"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"HTMLReactParser"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"html"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"ReturnType"),""),(0,r.kt)("p",null,"Converts HTML string to JSX element(s)."),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"html")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"HTML string.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"HTMLReactParserOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Parser options.")))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"ReturnType"),""),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"JSX element(s), empty array, or string.")),(0,r.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,r.kt)("p",null,"node_modules/html-react-parser/index.d.ts:51"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"addqueryargs"},"addQueryArgs"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"addQueryArgs"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"args"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"parameters-12"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">")))),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-39"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/url.ts#L167"},"packages/core/src/utils/url.ts:167")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"asyncforeach"},"asyncForEach"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"asyncForEach"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"array"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"callback"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"parameters-13"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"array")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"callback")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"el"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"index"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"number"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"array"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),"[]) => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("h4",{id:"defined-in-40"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/asyncForEach.ts#L1"},"packages/core/src/utils/asyncForEach.ts:1")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"attributestoprops"},"attributesToProps"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"attributesToProps"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"attributes"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"nodeName?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Props")),(0,r.kt)("p",null,"Converts HTML/SVG DOM attributes to React props."),(0,r.kt)("h4",{id:"parameters-14"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"attributes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Attributes")),(0,r.kt)("td",{parentName:"tr",align:"left"},"HTML/SVG DOM attributes.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"nodeName?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"DOM node name.")))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Props")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"React props.")),(0,r.kt)("h4",{id:"defined-in-41"},"Defined in"),(0,r.kt)("p",null,"node_modules/html-react-parser/lib/attributes-to-props.d.ts:17"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"buildquerystring"},"buildQueryString"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"buildQueryString"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"data"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Generates URL-encoded query string using input query data."),(0,r.kt)("p",null,"It is intended to behave equivalent as PHP's ",(0,r.kt)("inlineCode",{parentName:"p"},"http_build_query"),", configured\nwith encoding type PHP_QUERY_RFC3986 (spaces as ",(0,r.kt)("inlineCode",{parentName:"p"},"%20"),")."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"const queryString = buildQueryString( {\n simple: 'is ok',\n arrays: [ 'are', 'fine', 'too' ],\n objects: {\n evenNested: {\n ok: 'yes',\n },\n },\n} );\n// \"simple=is%20ok&arrays%5B0%5D=are&arrays%5B1%5D=fine&arrays%5B2%5D=too&objects%5BevenNested%5D%5Bok%5D=yes\"\n")),(0,r.kt)("h4",{id:"parameters-15"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Data to encode.")))),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Query string."),(0,r.kt)("h4",{id:"defined-in-42"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/url.ts#L129"},"packages/core/src/utils/url.ts:129")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"decodehtmlspeciachars"},"decodeHtmlSpeciaChars"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"decodeHtmlSpeciaChars"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"text"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Decodes HTML special chars entities"),(0,r.kt)("h4",{id:"parameters-16"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"text")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The text we want to decode")))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"text with decoded html entities"),(0,r.kt)("h4",{id:"defined-in-43"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/decodeHtmlSpeciaChars.ts#L8"},"packages/core/src/utils/decodeHtmlSpeciaChars.ts:8")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domtoreact"},"domToReact"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"domToReact"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"nodes"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element"),"[]"),(0,r.kt)("p",null,"Converts DOM nodes to JSX element(s)."),(0,r.kt)("h4",{id:"parameters-17"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"nodes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"DOM nodes.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"HTMLReactParserOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Parser options.")))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element"),"[]"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"JSX element(s).")),(0,r.kt)("h4",{id:"defined-in-44"},"Defined in"),(0,r.kt)("p",null,"node_modules/html-react-parser/lib/dom-to-react.d.ts:15"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchredirect"},"fetchRedirect"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchRedirect"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"pathname"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#redirectdata"},(0,r.kt)("inlineCode",{parentName:"a"},"RedirectData")),">"),(0,r.kt)("p",null,"Fetches a redirect from the WordPress origin by making a HEAD request and checking the response"),(0,r.kt)("h4",{id:"parameters-18"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pathname")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path to the page to fetch the redirect for")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The source url")))),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#redirectdata"},(0,r.kt)("inlineCode",{parentName:"a"},"RedirectData")),">"),(0,r.kt)("p",null,"The redirect data"),(0,r.kt)("h4",{id:"defined-in-45"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/fetchRedirect.ts#L51"},"packages/core/src/utils/fetchRedirect.ts:51")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAuthHeader"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"returns-19"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"defined-in-46"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/api/fetch-utils.ts#L3"},"packages/core/src/data/api/fetch-utils.ts:3")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcustomposttype"},"getCustomPostType"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCustomPostType"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"slug"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customposttype"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostType"))),(0,r.kt)("p",null,"Returns a single post type by slug if defined"),(0,r.kt)("h4",{id:"parameters-19"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"post type slug")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"})))),(0,r.kt)("h4",{id:"returns-20"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customposttype"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostType"))),(0,r.kt)("h4",{id:"defined-in-47"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/config.ts#L251"},"packages/core/src/utils/config.ts:251")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcustomposttypes"},"getCustomPostTypes"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCustomPostTypes"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customposttypes"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostTypes"))),(0,r.kt)("p",null,"Returns the available post types"),(0,r.kt)("h4",{id:"parameters-20"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-21"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customposttypes"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostTypes"))),(0,r.kt)("h4",{id:"defined-in-48"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/config.ts#L228"},"packages/core/src/utils/config.ts:228")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcustomposttypesslugs"},"getCustomPostTypesSlugs"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCustomPostTypesSlugs"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Returns the available post type slugs"),(0,r.kt)("h4",{id:"parameters-21"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-22"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("h4",{id:"defined-in-49"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/config.ts#L239"},"packages/core/src/utils/config.ts:239")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcustomtaxonomies"},"getCustomTaxonomies"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCustomTaxonomies"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customtaxonomies"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomies"))),(0,r.kt)("p",null,"Returns the available taxonomies"),(0,r.kt)("h4",{id:"parameters-22"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-23"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customtaxonomies"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomies"))),(0,r.kt)("h4",{id:"defined-in-50"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/config.ts#L188"},"packages/core/src/utils/config.ts:188")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcustomtaxonomy"},"getCustomTaxonomy"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCustomTaxonomy"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"slug"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customtaxonomy"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomy"))),(0,r.kt)("p",null,"Returns a single post type by slug if defined"),(0,r.kt)("h4",{id:"parameters-23"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"post type slug")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"})))),(0,r.kt)("h4",{id:"returns-24"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#customtaxonomy"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomy"))),(0,r.kt)("h4",{id:"defined-in-51"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/config.ts#L217"},"packages/core/src/utils/config.ts:217")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcustomtaxonomyslugs"},"getCustomTaxonomySlugs"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getCustomTaxonomySlugs"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Returns the available taxonomy slugs"),(0,r.kt)("h4",{id:"parameters-24"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-25"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("h4",{id:"defined-in-52"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/config.ts#L200"},"packages/core/src/utils/config.ts:200")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getheadlessconfig"},"getHeadlessConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getHeadlessConfig"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Returns the contents of headless.config.js"),(0,r.kt)("p",null,"This function requires framework integration in order to work. The contents of ",(0,r.kt)("inlineCode",{parentName:"p"},"headless.config.js"),"\nneeds to be injected at build time into a global variable."),(0,r.kt)("p",null,"Make sure you are using one of the framework's integration (such as next) before using this function."),(0,r.kt)("h4",{id:"returns-26"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The contents of headless.config.js"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customPostTypes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customposttypes"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostTypes")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customTaxonomies")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customtaxonomies"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomies")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"debug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"td"},"devMode?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"redirects?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"requests?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hostUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"integrations")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#integrations"},(0,r.kt)("inlineCode",{parentName:"a"},"Integrations")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"preview")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#previewconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewConfig")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"redirectStrategy")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#redirectstrategy"},(0,r.kt)("inlineCode",{parentName:"a"},"RedirectStrategy")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sites")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"useWordPressPlugin")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-53"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/config.ts#L22"},"packages/core/src/utils/config.ts:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getheadstartwpconfig"},"getHeadstartWPConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getHeadstartWPConfig"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Returns the contents of headless.config.js"),(0,r.kt)("p",null,"This function requires framework integration in order to work. The contents of ",(0,r.kt)("inlineCode",{parentName:"p"},"headless.config.js"),"\nneeds to be injected at build time into a global variable."),(0,r.kt)("p",null,"Make sure you are using one of the framework's integration (such as next) before using this function."),(0,r.kt)("h4",{id:"returns-27"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The contents of headless.config.js"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customPostTypes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customposttypes"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomPostTypes")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customTaxonomies")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#customtaxonomies"},(0,r.kt)("inlineCode",{parentName:"a"},"CustomTaxonomies")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"debug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"td"},"devMode?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"redirects?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"requests?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hostUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"integrations")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#integrations"},(0,r.kt)("inlineCode",{parentName:"a"},"Integrations")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"preview")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#previewconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewConfig")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"redirectStrategy")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#redirectstrategy"},(0,r.kt)("inlineCode",{parentName:"a"},"RedirectStrategy")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sites")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"useWordPressPlugin")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-54"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/config.ts#L22"},"packages/core/src/utils/config.ts:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"gethosturl"},"getHostUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getHostUrl"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Returns the WP URL based on the headless config"),(0,r.kt)("h4",{id:"returns-28"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-55"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/config.ts#L268"},"packages/core/src/utils/config.ts:268")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getqueryargs"},"getQueryArgs"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getQueryArgs"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Returns an object of query arguments of the given URL. If the given URL is\ninvalid or has no querystring, an empty object is returned."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},'const foo = getQueryArgs( \'https://wordpress.org?foo=bar&bar=baz\' );\n// { "foo": "bar", "bar": "baz" }\n')),(0,r.kt)("h4",{id:"parameters-25"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"URL.")))),(0,r.kt)("h4",{id:"returns-29"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"Query args object."),(0,r.kt)("h4",{id:"defined-in-56"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/url.ts#L78"},"packages/core/src/utils/url.ts:78")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getquerystring"},"getQueryString"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getQueryString"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h4",{id:"parameters-26"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-30"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h4",{id:"defined-in-57"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/url.ts#L49"},"packages/core/src/utils/url.ts:49")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsite"},"getSite"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSite"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("p",null,"Get a config for a specific site"),(0,r.kt)("h4",{id:"parameters-27"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h4",{id:"returns-31"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("h4",{id:"defined-in-58"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/config.ts#L113"},"packages/core/src/utils/config.ts:113")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsitebyhost"},"getSiteByHost"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSiteByHost"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"hostOrUrl"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"locale?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("p",null,"Finds a site by host and optionally locale"),(0,r.kt)("h4",{id:"parameters-28"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hostOrUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The hostname")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"locale?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"})))),(0,r.kt)("h4",{id:"returns-32"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("h4",{id:"defined-in-59"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/config.ts#L138"},"packages/core/src/utils/config.ts:138")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsitebysourceurl"},"getSiteBySourceUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSiteBySourceUrl"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("p",null,"Get a site by source url"),(0,r.kt)("h4",{id:"parameters-29"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-33"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("p",null,"HeadlessConfig"),(0,r.kt)("h4",{id:"defined-in-60"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/config.ts#L176"},"packages/core/src/utils/config.ts:176")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getwpurl"},"getWPUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getWPUrl"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Returns the WP URL based on the headless config"),(0,r.kt)("h4",{id:"returns-34"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-61"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/config.ts#L260"},"packages/core/src/utils/config.ts:260")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"htmltodom"},"htmlToDOM"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"htmlToDOM"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"html"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): (",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Comment"},(0,r.kt)("inlineCode",{parentName:"a"},"Comment"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.ProcessingInstruction"},(0,r.kt)("inlineCode",{parentName:"a"},"ProcessingInstruction"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Text"},(0,r.kt)("inlineCode",{parentName:"a"},"Text")),")[]"),(0,r.kt)("p",null,"Parses HTML string to DOM nodes in Node.js."),(0,r.kt)("p",null,"This is the same method as ",(0,r.kt)("inlineCode",{parentName:"p"},"require('htmlparser2').parseDOM"),"\n",(0,r.kt)("a",{parentName:"p",href:"https://github.com/fb55/htmlparser2/blob/v6.0.0/src/index.ts#L29-L41"},"https://github.com/fb55/htmlparser2/blob/v6.0.0/src/index.ts#L29-L41")),(0,r.kt)("h4",{id:"parameters-30"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"html")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"HTML markup.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"DomHandlerOptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Parser options (",(0,r.kt)("a",{parentName:"td",href:"https://github.com/fb55/domhandler/tree/v5.0.3#readme"},"https://github.com/fb55/domhandler/tree/v5.0.3#readme"),").")))),(0,r.kt)("h4",{id:"returns-35"},"Returns"),(0,r.kt)("p",null,"(",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Comment"},(0,r.kt)("inlineCode",{parentName:"a"},"Comment"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.ProcessingInstruction"},(0,r.kt)("inlineCode",{parentName:"a"},"ProcessingInstruction"))," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Text"},(0,r.kt)("inlineCode",{parentName:"a"},"Text")),")[]"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"DOM nodes.")),(0,r.kt)("h4",{id:"defined-in-62"},"Defined in"),(0,r.kt)("p",null,"node_modules/html-dom-parser/lib/server/html-to-dom.d.ts:21"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"iselement"},"isElement"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isElement"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): node is Element"),(0,r.kt)("p",null,"Checks if the node is an Element."),(0,r.kt)("p",null,"We rely on this function to avoid issues with instanceof."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/issues/504"},"https://github.com/10up/headstartwp/issues/504")),(0,r.kt)("h4",{id:"parameters-31"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#domnode"},(0,r.kt)("inlineCode",{parentName:"a"},"DOMNode"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The dom node")))),(0,r.kt)("h4",{id:"returns-36"},"Returns"),(0,r.kt)("p",null,"node is Element"),(0,r.kt)("p",null,"Whether the node is of type element or not"),(0,r.kt)("h4",{id:"defined-in-63"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/dom/index.ts#L25"},"packages/core/src/dom/index.ts:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isexternalurl"},"isExternalUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isExternalUrl"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"link"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Checks if the provided link is an external Url."),(0,r.kt)("p",null,"Inspired on the Frontity implementation"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/frontity/frontity/blob/dev/packages/components/link/utils.ts"},"https://github.com/frontity/frontity/blob/dev/packages/components/link/utils.ts")),(0,r.kt)("h4",{id:"parameters-32"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"link")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The link Url.")))),(0,r.kt)("h4",{id:"returns-37"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"True if the link is an external Url."),(0,r.kt)("h4",{id:"defined-in-64"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/isExternalUrl.ts#L12"},"packages/core/src/utils/isExternalUrl.ts:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"isinternallink"},"isInternalLink"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"isInternalLink"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Checks if the url is for an internal link"),(0,r.kt)("h4",{id:"parameters-33"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The url to check")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"(optional) the site config")))),(0,r.kt)("h4",{id:"returns-38"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-65"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/isInternalLink.ts#L14"},"packages/core/src/utils/isInternalLink.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"log"},"log"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"log"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"type"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"...args"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-34"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"type")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/enums/headstartwp_core.LOGTYPE"},(0,r.kt)("inlineCode",{parentName:"a"},"LOGTYPE")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"...args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"),"[]")))),(0,r.kt)("h4",{id:"returns-39"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-66"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/log.ts#L9"},"packages/core/src/utils/log.ts:9")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removefieldsfrompostrelateddata"},"removeFieldsFromPostRelatedData"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeFieldsFromPostRelatedData"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"fieldsToRemove"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"post"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"p"},"_embedded"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"author"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"wp:featuredmedia"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"wp:term"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]"," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"author?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"categories?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"comment_status?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"closed"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"content"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"date"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"date_gmt"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"excerpt"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"featured_media"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"format"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"link"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"status"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"standard"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"aside"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"chat"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"gallery"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"image"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"quote"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"video"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"audio"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"guid"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"link"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"modified"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"modified_gmt"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"ping_status"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"closed"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"status"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"publish"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"future"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"draft"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"pending"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"private"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"sticky"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"tags?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"template"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"terms?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"title"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"yoast_head?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"yoast_head_json?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"," }"),(0,r.kt)("h4",{id:"parameters-35"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fieldsToRemove")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"number"),")[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"post")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity")))))),(0,r.kt)("h4",{id:"returns-40"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"p"},"_embedded"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"author"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"wp:featuredmedia"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"wp:term"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]"," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"author?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"categories?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"comment_status?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"closed"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"content"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"date"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"date_gmt"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"excerpt"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"featured_media"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"format"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"link"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"status"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"standard"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"aside"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"chat"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"gallery"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"image"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"quote"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"video"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"audio"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"guid"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"link"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"modified"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"modified_gmt"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"ping_status"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"closed"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"status"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"publish"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"future"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"draft"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"pending"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"private"')," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"sticky"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"tags?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"template"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"terms?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"title"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"type"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"yoast_head?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"yoast_head_json?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"," }"),(0,r.kt)("h4",{id:"defined-in-67"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/utils/postHandling.ts#L51"},"packages/core/src/data/utils/postHandling.ts:51")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"removesourceurl"},"removeSourceUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"removeSourceUrl"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Make the link relative if it belongs to the backend, to force client-side\nnavigation."),(0,r.kt)("p",null,"Inspired on the Frontity implementation"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/frontity/frontity/blob/dev/packages/components/link/utils.ts"},"https://github.com/frontity/frontity/blob/dev/packages/components/link/utils.ts")),(0,r.kt)("h4",{id:"parameters-36"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#removesourceurltype"},(0,r.kt)("inlineCode",{parentName:"a"},"removeSourceUrlType")))))),(0,r.kt)("h4",{id:"returns-41"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The URL without the Source URL."),(0,r.kt)("h4",{id:"defined-in-68"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/removeSourceUrl.ts#L42"},"packages/core/src/utils/removeSourceUrl.ts:42")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setheadlessconfig"},"setHeadlessConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setHeadlessConfig"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"config"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-37"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"config")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h4",{id:"returns-42"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-69"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/config.ts#L6"},"packages/core/src/utils/config.ts:6")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"setheadstartwpconfig"},"setHeadstartWPConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"setHeadstartWPConfig"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"config"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"parameters-38"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"config")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h4",{id:"returns-43"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-70"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/config.ts#L6"},"packages/core/src/utils/config.ts:6")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"striptags"},"stripTags"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"stripTags"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"html"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("p",null,"Utility functions to strip any tags"),(0,r.kt)("h4",{id:"parameters-39"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"html")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The html string")))),(0,r.kt)("h4",{id:"returns-44"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h4",{id:"defined-in-71"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/dom/stripTags.ts#L8"},"packages/core/src/dom/stripTags.ts:8")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"warn"},"warn"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"warn"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"message"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("p",null,"Logs a warning in the console in dev mode"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},'warn("You should do/change something.")\n')),(0,r.kt)("h4",{id:"parameters-40"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"message")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The message that describes the warning.")))),(0,r.kt)("h4",{id:"returns-45"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"void")),(0,r.kt)("h4",{id:"defined-in-72"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/errors.ts#L45"},"packages/core/src/utils/errors.ts:45")),(0,r.kt)("h2",{id:"utility-functions"},"Utility Functions"),(0,r.kt)("h3",{id:"parsepath"},"parsePath"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"parsePath"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"matchers"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Parses a path and extracts the parameters from it"),(0,r.kt)("h4",{id:"parameters-41"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"matchers")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#matcher"},(0,r.kt)("inlineCode",{parentName:"a"},"Matcher")),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"An array of Matchers")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path")))),(0,r.kt)("h4",{id:"returns-46"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"the extracted parameters"),(0,r.kt)("h4",{id:"defined-in-73"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/utils/parsePath.ts#L46"},"packages/core/src/data/utils/parsePath.ts:46")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/0f4f470d.6da3a261.js b/assets/js/0f4f470d.c64b03e4.js similarity index 95% rename from assets/js/0f4f470d.6da3a261.js rename to assets/js/0f4f470d.c64b03e4.js index cc47a7487..9660b6fe7 100644 --- a/assets/js/0f4f470d.6da3a261.js +++ b/assets/js/0f4f470d.c64b03e4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9050],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function l(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(r),u=n,m=s["".concat(p,".").concat(u)]||s[u]||k[u]||l;return r?a.createElement(m,i(i({ref:t},d),{},{components:r})):a.createElement(m,i({ref:t},d))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=r.length,i=new Array(l);i[0]=u;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const l={id:"headstartwp_core.react.PullQuoteBlockProps",title:"Interface: PullQuoteBlockProps",sidebar_label:"@headstartwp/core.react.PullQuoteBlockProps",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.PullQuoteBlockProps",id:"interfaces/headstartwp_core.react.PullQuoteBlockProps",title:"Interface: PullQuoteBlockProps",description:"@headstartwp/core.react.PullQuoteBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.PullQuoteBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.PullQuoteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.PullQuoteBlockProps",title:"Interface: PullQuoteBlockProps",sidebar_label:"@headstartwp/core.react.PullQuoteBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.PreformattedBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps"},next:{title:"@headstartwp/core.react.QuoteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"borderColor",id:"bordercolor",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"cite",id:"cite",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"quote",id:"quote",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-9",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".PullQuoteBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"PullQuoteBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"bordercolor"},"borderColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"borderColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/PullQuote.tsx#L10"},"packages/core/src/react/blocks/PullQuote.tsx:10")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"cite"},"cite"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"cite"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/PullQuote.tsx#L9"},"packages/core/src/react/blocks/PullQuote.tsx:9")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"quote"},"quote"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"quote"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/PullQuote.tsx#L8"},"packages/core/src/react/blocks/PullQuote.tsx:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9050],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function l(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(r),u=n,m=s["".concat(p,".").concat(u)]||s[u]||k[u]||l;return r?a.createElement(m,i(i({ref:t},d),{},{components:r})):a.createElement(m,i({ref:t},d))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=r.length,i=new Array(l);i[0]=u;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const l={id:"headstartwp_core.react.PullQuoteBlockProps",title:"Interface: PullQuoteBlockProps",sidebar_label:"@headstartwp/core.react.PullQuoteBlockProps",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.PullQuoteBlockProps",id:"interfaces/headstartwp_core.react.PullQuoteBlockProps",title:"Interface: PullQuoteBlockProps",description:"@headstartwp/core.react.PullQuoteBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.PullQuoteBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.PullQuoteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.PullQuoteBlockProps",title:"Interface: PullQuoteBlockProps",sidebar_label:"@headstartwp/core.react.PullQuoteBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.PreformattedBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps"},next:{title:"@headstartwp/core.react.QuoteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"borderColor",id:"bordercolor",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"cite",id:"cite",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"quote",id:"quote",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-9",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".PullQuoteBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"PullQuoteBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"bordercolor"},"borderColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"borderColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/PullQuote.tsx#L10"},"packages/core/src/react/blocks/PullQuote.tsx:10")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"cite"},"cite"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"cite"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/PullQuote.tsx#L9"},"packages/core/src/react/blocks/PullQuote.tsx:9")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"quote"},"quote"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"quote"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/PullQuote.tsx#L8"},"packages/core/src/react/blocks/PullQuote.tsx:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/0f702274.56739942.js b/assets/js/0f702274.9931f30b.js similarity index 96% rename from assets/js/0f702274.56739942.js rename to assets/js/0f702274.9931f30b.js index b690e52ca..b1fde9b5a 100644 --- a/assets/js/0f702274.56739942.js +++ b/assets/js/0f702274.9931f30b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3222],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var d=r.createContext({}),s=function(e){var t=r.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=s(e.components);return r.createElement(d.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,d=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),c=s(a),m=n,k=c["".concat(d,".").concat(m)]||c[m]||h[m]||i;return a?r.createElement(k,p(p({ref:t},o),{},{components:a})):r.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=m;var l={};for(var d in t)hasOwnProperty.call(t,d)&&(l[d]=t[d]);l.originalType=e,l[c]="string"==typeof e?e:n,p[1]=l;for(var s=2;s{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>s});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.SearchNativeFetchStrategy",title:"Class: SearchNativeFetchStrategy",sidebar_label:"@headstartwp/core.SearchNativeFetchStrategy",custom_edit_url:null},p=void 0,l={unversionedId:"classes/headstartwp_core.SearchNativeFetchStrategy",id:"classes/headstartwp_core.SearchNativeFetchStrategy",title:"Class: SearchNativeFetchStrategy",description:"@headstartwp/core.SearchNativeFetchStrategy",source:"@site/docs/classes/headstartwp_core.SearchNativeFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.SearchNativeFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.SearchNativeFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.SearchNativeFetchStrategy",title:"Class: SearchNativeFetchStrategy",sidebar_label:"@headstartwp/core.SearchNativeFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.SearchFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.SearchFetchStrategy"},next:{title:"@headstartwp/core.SinglePostFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy"}},d={},s=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"locale",id:"locale",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"path",id:"path",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-4",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getPreviewAuthHeader",id:"getpreviewauthheader",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"getPreviewHeaderName",id:"getpreviewheadername",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-23",level:4}],o={toc:s};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".SearchNativeFetchStrategy"),(0,n.kt)("p",null,"The SearchNativeFetchStrategy is used to fetch search results for a given search query\nUses the native WordPress search endpoint."),(0,n.kt)("p",null,"Note that custom post types and custom taxonomies should be defined in ",(0,n.kt)("inlineCode",{parentName:"p"},"headless.config.js")),(0,n.kt)("p",null,"This strategy supports extracting endpoint params from url E.g:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/page/2/")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ page: 2 }")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/searched-term/page/2")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ search: 'searched-term', page: 2 }"))),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"See"))),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.SearchNativeFetchStrategy#getparamsfromurl"},"getParamsFromURL")," to learn about url param mapping"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostSearchEntity"))," ","|"," ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermSearchEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermSearchEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostSearchEntity"))," ","|"," ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermSearchEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermSearchEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.SearchParams"},(0,n.kt)("inlineCode",{parentName:"a"},"SearchParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.SearchParams"},(0,n.kt)("inlineCode",{parentName:"a"},"SearchParams")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"SearchNativeFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new SearchNativeFetchStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostSearchEntity"))," ","|"," ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermSearchEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermSearchEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostSearchEntity"))," ","|"," ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermSearchEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermSearchEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.SearchParams"},(0,n.kt)("inlineCode",{parentName:"a"},"SearchParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.SearchParams"},(0,n.kt)("inlineCode",{parentName:"a"},"SearchParams")))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L143"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:143")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L119"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:119")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L124"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:124")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"locale"},"locale"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"locale"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SearchNativeFetchStrategy.ts#L75"},"packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"path"},"path"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"path"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SearchNativeFetchStrategy.ts#L73"},"packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:73")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Builds the endpoint url for the search endpoint"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params for the request")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SearchNativeFetchStrategy.ts#L106"},"packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:106")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,n.kt)("inlineCode",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[] }",">"),(0,n.kt)("p",null,"The fetcher function is overridden to disable throwing if not found"),(0,n.kt)("p",null,"If a search request returns not found we do not want to redirect to a 404 page,\ninstead the user should be informed that no posts were found"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The url to parse")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint with")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"FetchOptions")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,n.kt)("inlineCode",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[] }",">"),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SearchNativeFetchStrategy.ts#L125"},"packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:125")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"filterOptions?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"filterOptions?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L377"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:377")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L442"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:442")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L256"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:256")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L407"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:407")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides-2"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SearchNativeFetchStrategy.ts#L77"},"packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides-3"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SearchNativeFetchStrategy.ts#L81"},"packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:81")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L174"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:174")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"This strategy automatically extracts the search term and and pagination params from the URL"),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL path to extract params from")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params passed to the strategy")))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides-4"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SearchNativeFetchStrategy.ts#L91"},"packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:91")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewauthheader"},"getPreviewAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getpreviewauthheader"},"getPreviewAuthHeader")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L247"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:247")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewheadername"},"getPreviewHeaderName"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewHeaderName"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getpreviewheadername"},"getPreviewHeaderName")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L241"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:241")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L365"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:365")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L205"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:205")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L417"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:417")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L233"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:233")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-14"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-16"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L164"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:164")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-15"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-17"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3222],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var d=r.createContext({}),s=function(e){var t=r.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=s(e.components);return r.createElement(d.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,d=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),c=s(a),m=n,k=c["".concat(d,".").concat(m)]||c[m]||h[m]||i;return a?r.createElement(k,p(p({ref:t},o),{},{components:a})):r.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=m;var l={};for(var d in t)hasOwnProperty.call(t,d)&&(l[d]=t[d]);l.originalType=e,l[c]="string"==typeof e?e:n,p[1]=l;for(var s=2;s{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>s});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.SearchNativeFetchStrategy",title:"Class: SearchNativeFetchStrategy",sidebar_label:"@headstartwp/core.SearchNativeFetchStrategy",custom_edit_url:null},p=void 0,l={unversionedId:"classes/headstartwp_core.SearchNativeFetchStrategy",id:"classes/headstartwp_core.SearchNativeFetchStrategy",title:"Class: SearchNativeFetchStrategy",description:"@headstartwp/core.SearchNativeFetchStrategy",source:"@site/docs/classes/headstartwp_core.SearchNativeFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.SearchNativeFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.SearchNativeFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.SearchNativeFetchStrategy",title:"Class: SearchNativeFetchStrategy",sidebar_label:"@headstartwp/core.SearchNativeFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.SearchFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.SearchFetchStrategy"},next:{title:"@headstartwp/core.SinglePostFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy"}},d={},s=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"locale",id:"locale",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"path",id:"path",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-4",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getPreviewAuthHeader",id:"getpreviewauthheader",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"getPreviewHeaderName",id:"getpreviewheadername",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-23",level:4}],o={toc:s};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".SearchNativeFetchStrategy"),(0,n.kt)("p",null,"The SearchNativeFetchStrategy is used to fetch search results for a given search query\nUses the native WordPress search endpoint."),(0,n.kt)("p",null,"Note that custom post types and custom taxonomies should be defined in ",(0,n.kt)("inlineCode",{parentName:"p"},"headless.config.js")),(0,n.kt)("p",null,"This strategy supports extracting endpoint params from url E.g:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/page/2/")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ page: 2 }")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/searched-term/page/2")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ search: 'searched-term', page: 2 }"))),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"See"))),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.SearchNativeFetchStrategy#getparamsfromurl"},"getParamsFromURL")," to learn about url param mapping"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostSearchEntity"))," ","|"," ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermSearchEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermSearchEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostSearchEntity"))," ","|"," ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermSearchEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermSearchEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.SearchParams"},(0,n.kt)("inlineCode",{parentName:"a"},"SearchParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.SearchParams"},(0,n.kt)("inlineCode",{parentName:"a"},"SearchParams")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"SearchNativeFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new SearchNativeFetchStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostSearchEntity"))," ","|"," ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermSearchEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermSearchEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostSearchEntity"))," ","|"," ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermSearchEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermSearchEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.SearchParams"},(0,n.kt)("inlineCode",{parentName:"a"},"SearchParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.SearchParams"},(0,n.kt)("inlineCode",{parentName:"a"},"SearchParams")))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L143"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:143")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L119"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:119")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L124"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:124")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"locale"},"locale"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"locale"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SearchNativeFetchStrategy.ts#L75"},"packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"path"},"path"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"path"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SearchNativeFetchStrategy.ts#L73"},"packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:73")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Builds the endpoint url for the search endpoint"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params for the request")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SearchNativeFetchStrategy.ts#L106"},"packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:106")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,n.kt)("inlineCode",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[] }",">"),(0,n.kt)("p",null,"The fetcher function is overridden to disable throwing if not found"),(0,n.kt)("p",null,"If a search request returns not found we do not want to redirect to a 404 page,\ninstead the user should be informed that no posts were found"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The url to parse")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint with")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"FetchOptions")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,n.kt)("inlineCode",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[] }",">"),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SearchNativeFetchStrategy.ts#L125"},"packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:125")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"filterOptions?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"filterOptions?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L377"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:377")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L442"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:442")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L256"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:256")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L407"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:407")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides-2"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SearchNativeFetchStrategy.ts#L77"},"packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides-3"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SearchNativeFetchStrategy.ts#L81"},"packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:81")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L174"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:174")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"This strategy automatically extracts the search term and and pagination params from the URL"),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL path to extract params from")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params passed to the strategy")))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides-4"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SearchNativeFetchStrategy.ts#L91"},"packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:91")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewauthheader"},"getPreviewAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getpreviewauthheader"},"getPreviewAuthHeader")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L247"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:247")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewheadername"},"getPreviewHeaderName"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewHeaderName"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getpreviewheadername"},"getPreviewHeaderName")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L241"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:241")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L365"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:365")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L205"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:205")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L417"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:417")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L233"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:233")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-14"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-16"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L164"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:164")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-15"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-17"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/0f7b7d82.fd021be6.js b/assets/js/0f7b7d82.c74dbad0.js similarity index 96% rename from assets/js/0f7b7d82.fd021be6.js rename to assets/js/0f7b7d82.c74dbad0.js index bdd1fd241..afc027a8f 100644 --- a/assets/js/0f7b7d82.fd021be6.js +++ b/assets/js/0f7b7d82.c74dbad0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3533],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),s=c(r),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return r?a.createElement(h,o(o({ref:t},d),{},{components:r})):a.createElement(h,o({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[s]="string"==typeof e?e:n,o[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.PreformattedBlockProps",title:"Interface: PreformattedBlockProps",sidebar_label:"@headstartwp/core.react.PreformattedBlockProps",custom_edit_url:null},o=void 0,l={unversionedId:"interfaces/headstartwp_core.react.PreformattedBlockProps",id:"interfaces/headstartwp_core.react.PreformattedBlockProps",title:"Interface: PreformattedBlockProps",description:"@headstartwp/core.react.PreformattedBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.PreformattedBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.PreformattedBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.PreformattedBlockProps",title:"Interface: PreformattedBlockProps",sidebar_label:"@headstartwp/core.react.PreformattedBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ParagraphBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps"},next:{title:"@headstartwp/core.react.PullQuoteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".PreformattedBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"PreformattedBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3533],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),s=c(r),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return r?a.createElement(h,o(o({ref:t},d),{},{components:r})):a.createElement(h,o({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[s]="string"==typeof e?e:n,o[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.PreformattedBlockProps",title:"Interface: PreformattedBlockProps",sidebar_label:"@headstartwp/core.react.PreformattedBlockProps",custom_edit_url:null},o=void 0,l={unversionedId:"interfaces/headstartwp_core.react.PreformattedBlockProps",id:"interfaces/headstartwp_core.react.PreformattedBlockProps",title:"Interface: PreformattedBlockProps",description:"@headstartwp/core.react.PreformattedBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.PreformattedBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.PreformattedBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.PreformattedBlockProps",title:"Interface: PreformattedBlockProps",sidebar_label:"@headstartwp/core.react.PreformattedBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ParagraphBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps"},next:{title:"@headstartwp/core.react.PullQuoteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".PreformattedBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"PreformattedBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/10176796.cfe711d7.js b/assets/js/10176796.99817444.js similarity index 94% rename from assets/js/10176796.cfe711d7.js rename to assets/js/10176796.99817444.js index c1490552d..772a69581 100644 --- a/assets/js/10176796.cfe711d7.js +++ b/assets/js/10176796.99817444.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4470],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>u});var a=r(7294);function p(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function n(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t=0||(p[r]=e[r]);return p}(e,t);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(p[r]=e[r])}return p}var l=a.createContext({}),o=function(e){var t=a.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},c=function(e){var t=o(e.components);return a.createElement(l.Provider,{value:t},e.children)},d="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var r=e.components,p=e.mdxType,n=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=o(r),h=p,u=d["".concat(l,".").concat(h)]||d[h]||m[h]||n;return r?a.createElement(u,i(i({ref:t},c),{},{components:r})):a.createElement(u,i({ref:t},c))}));function u(e,t){var r=arguments,p=t&&t.mdxType;if("string"==typeof e||p){var n=r.length,i=new Array(n);i[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[d]="string"==typeof e?e:p,i[1]=s;for(var o=2;o{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>n,metadata:()=>s,toc:()=>o});var a=r(7462),p=(r(7294),r(3905));const n={id:"headstartwp_core.react.StylesElementsPropertiesComplete",title:"Interface: StylesElementsPropertiesComplete",sidebar_label:"@headstartwp/core.react.StylesElementsPropertiesComplete",custom_edit_url:null},i=void 0,s={unversionedId:"interfaces/headstartwp_core.react.StylesElementsPropertiesComplete",id:"interfaces/headstartwp_core.react.StylesElementsPropertiesComplete",title:"Interface: StylesElementsPropertiesComplete",description:"@headstartwp/core.react.StylesElementsPropertiesComplete",source:"@site/docs/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete",permalink:"/docs/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.StylesElementsPropertiesComplete",title:"Interface: StylesElementsPropertiesComplete",sidebar_label:"@headstartwp/core.react.StylesElementsPropertiesComplete",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.SpacerBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps"},next:{title:"@headstartwp/core.react.StylesProperties",permalink:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"}},l={},o=[{value:"Properties",id:"properties",level:2},{value:"h1",id:"h1",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"h2",id:"h2",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"h3",id:"h3",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"h4",id:"h4",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"h5",id:"h5",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"h6",id:"h6",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"link",id:"link",level:3},{value:"Defined in",id:"defined-in-6",level:4}],c={toc:o};function d(e){let{components:t,...r}=e;return(0,p.kt)("wrapper",(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".StylesElementsPropertiesComplete"),(0,p.kt)("h2",{id:"properties"},"Properties"),(0,p.kt)("h3",{id:"h1"},"h1"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"h1"),": ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,p.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L682"},"packages/core/src/react/provider/types.ts:682")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"h2"},"h2"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"h2"),": ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,p.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L683"},"packages/core/src/react/provider/types.ts:683")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"h3"},"h3"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"h3"),": ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,p.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))),(0,p.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L684"},"packages/core/src/react/provider/types.ts:684")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"h4"},"h4"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"h4"),": ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,p.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))),(0,p.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L685"},"packages/core/src/react/provider/types.ts:685")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"h5"},"h5"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"h5"),": ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,p.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))),(0,p.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L686"},"packages/core/src/react/provider/types.ts:686")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"h6"},"h6"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"h6"),": ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,p.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))),(0,p.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L687"},"packages/core/src/react/provider/types.ts:687")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"link"},"link"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"link"),": ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,p.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))),(0,p.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L681"},"packages/core/src/react/provider/types.ts:681")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4470],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>u});var a=r(7294);function p(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function n(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t=0||(p[r]=e[r]);return p}(e,t);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(p[r]=e[r])}return p}var l=a.createContext({}),o=function(e){var t=a.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},c=function(e){var t=o(e.components);return a.createElement(l.Provider,{value:t},e.children)},d="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var r=e.components,p=e.mdxType,n=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=o(r),h=p,u=d["".concat(l,".").concat(h)]||d[h]||m[h]||n;return r?a.createElement(u,i(i({ref:t},c),{},{components:r})):a.createElement(u,i({ref:t},c))}));function u(e,t){var r=arguments,p=t&&t.mdxType;if("string"==typeof e||p){var n=r.length,i=new Array(n);i[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[d]="string"==typeof e?e:p,i[1]=s;for(var o=2;o{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>n,metadata:()=>s,toc:()=>o});var a=r(7462),p=(r(7294),r(3905));const n={id:"headstartwp_core.react.StylesElementsPropertiesComplete",title:"Interface: StylesElementsPropertiesComplete",sidebar_label:"@headstartwp/core.react.StylesElementsPropertiesComplete",custom_edit_url:null},i=void 0,s={unversionedId:"interfaces/headstartwp_core.react.StylesElementsPropertiesComplete",id:"interfaces/headstartwp_core.react.StylesElementsPropertiesComplete",title:"Interface: StylesElementsPropertiesComplete",description:"@headstartwp/core.react.StylesElementsPropertiesComplete",source:"@site/docs/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete",permalink:"/docs/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.StylesElementsPropertiesComplete",title:"Interface: StylesElementsPropertiesComplete",sidebar_label:"@headstartwp/core.react.StylesElementsPropertiesComplete",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.SpacerBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps"},next:{title:"@headstartwp/core.react.StylesProperties",permalink:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"}},l={},o=[{value:"Properties",id:"properties",level:2},{value:"h1",id:"h1",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"h2",id:"h2",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"h3",id:"h3",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"h4",id:"h4",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"h5",id:"h5",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"h6",id:"h6",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"link",id:"link",level:3},{value:"Defined in",id:"defined-in-6",level:4}],c={toc:o};function d(e){let{components:t,...r}=e;return(0,p.kt)("wrapper",(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".StylesElementsPropertiesComplete"),(0,p.kt)("h2",{id:"properties"},"Properties"),(0,p.kt)("h3",{id:"h1"},"h1"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"h1"),": ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,p.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))),(0,p.kt)("h4",{id:"defined-in"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L682"},"packages/core/src/react/provider/types.ts:682")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"h2"},"h2"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"h2"),": ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,p.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))),(0,p.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L683"},"packages/core/src/react/provider/types.ts:683")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"h3"},"h3"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"h3"),": ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,p.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))),(0,p.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L684"},"packages/core/src/react/provider/types.ts:684")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"h4"},"h4"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"h4"),": ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,p.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))),(0,p.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L685"},"packages/core/src/react/provider/types.ts:685")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"h5"},"h5"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"h5"),": ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,p.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))),(0,p.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L686"},"packages/core/src/react/provider/types.ts:686")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"h6"},"h6"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"h6"),": ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,p.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))),(0,p.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L687"},"packages/core/src/react/provider/types.ts:687")),(0,p.kt)("hr",null),(0,p.kt)("h3",{id:"link"},"link"),(0,p.kt)("p",null,"\u2022 ",(0,p.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,p.kt)("strong",{parentName:"p"},"link"),": ",(0,p.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,p.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))),(0,p.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,p.kt)("p",null,(0,p.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L681"},"packages/core/src/react/provider/types.ts:681")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/126717b4.b51823c7.js b/assets/js/126717b4.62890a9d.js similarity index 98% rename from assets/js/126717b4.b51823c7.js rename to assets/js/126717b4.62890a9d.js index 36f7da74d..f41f27b7a 100644 --- a/assets/js/126717b4.b51823c7.js +++ b/assets/js/126717b4.62890a9d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1247],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>N});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),d=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},s=function(e){var t=d(e.components);return n.createElement(p.Provider,{value:t},e.children)},m="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},c=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,p=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),m=d(a),c=r,N=m["".concat(p,".").concat(c)]||m[c]||k[c]||l;return a?n.createElement(N,i(i({ref:t},s),{},{components:a})):n.createElement(N,i({ref:t},s))}));function N(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,i=new Array(l);i[0]=c;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[m]="string"==typeof e?e:r,i[1]=o;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>m,frontMatter:()=>l,metadata:()=>o,toc:()=>d});var n=a(7462),r=(a(7294),a(3905));const l={id:"headstartwp_core.react.SettingsProperties",title:"Interface: SettingsProperties",sidebar_label:"@headstartwp/core.react.SettingsProperties",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.SettingsProperties",id:"interfaces/headstartwp_core.react.SettingsProperties",title:"Interface: SettingsProperties",description:"@headstartwp/core.react.SettingsProperties",source:"@site/docs/interfaces/headstartwp_core.react.SettingsProperties.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.SettingsProperties",permalink:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.SettingsProperties",title:"Interface: SettingsProperties",sidebar_label:"@headstartwp/core.react.SettingsProperties",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.SettingsCustomAdditionalProperties",permalink:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties"},next:{title:"@headstartwp/core.react.SpacerBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps"}},p={},d=[{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"appearanceTools",id:"appearancetools",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"border",id:"border",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"color",id:"color",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"custom",id:"custom",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"layout",id:"layout",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"spacing",id:"spacing",level:3},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"typography",id:"typography",level:3},{value:"Type declaration",id:"type-declaration-4",level:4},{value:"Defined in",id:"defined-in-6",level:4}],s={toc:d};function m(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".SettingsProperties"),(0,r.kt)("h2",{id:"indexable"},"Indexable"),(0,r.kt)("p",null,"\u25aa ","[k: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"appearancetools"},"appearanceTools"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"appearanceTools"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Setting that enables ui tools."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L358"},"packages/core/src/react/provider/types.ts:358")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"border"},"border"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"border"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Settings related to borders."),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"color?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom border colors.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"radius?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom border radius.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"style?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom border styles.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"width?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom border widths.")))),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L362"},"packages/core/src/react/provider/types.ts:362")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"color"},"color"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"color"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Settings related to colors."),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"background?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set background colors.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"custom?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to select custom colors.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customDuotone?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to create custom duotone filters.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customGradient?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to create custom gradients.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"defaultGradients?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to choose colors from the default gradients.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"defaultPalette?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to choose colors from the default palette.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"duotone?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsduotone"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsDuotone"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Duotone presets for the duotone picker. Doesn't generate classes or properties.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"gradients?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsgradient"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsGradient"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Gradient presets for the gradient picker. Generates a single class (",(0,r.kt)("inlineCode",{parentName:"td"},".has-{slug}-background"),") and custom property (",(0,r.kt)("inlineCode",{parentName:"td"},"--wp--preset--gradient--{slug}"),") per preset value.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"link?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set link colors.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"palette?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingscolorpalette"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsColorPalette"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Color palette presets for the color picker. Generates three classes (",(0,r.kt)("inlineCode",{parentName:"td"},".has-{slug}-color"),", ",(0,r.kt)("inlineCode",{parentName:"td"},".has-{slug}-background-color"),", and ",(0,r.kt)("inlineCode",{parentName:"td"},".has-{slug}-border-color"),") and a single custom property (",(0,r.kt)("inlineCode",{parentName:"td"},"--wp--preset--color--{slug}"),") per preset value.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"text?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set text colors.")))),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L383"},"packages/core/src/react/provider/types.ts:383")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"custom"},"custom"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"custom"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Generate custom CSS custom properties of the form ",(0,r.kt)("inlineCode",{parentName:"p"},"--wp--custom--{key}--{nested-key}: {value};"),". ",(0,r.kt)("inlineCode",{parentName:"p"},"camelCased")," keys are transformed to ",(0,r.kt)("inlineCode",{parentName:"p"},"kebab-case")," as to follow the CSS property naming schema. Keys at different depth levels are separated by ",(0,r.kt)("inlineCode",{parentName:"p"},"--"),", so keys should not include ",(0,r.kt)("inlineCode",{parentName:"p"},"--")," in the name."),(0,r.kt)("h4",{id:"index-signature"},"Index signature"),(0,r.kt)("p",null,"\u25aa ","[k: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsCustomAdditionalProperties"))),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L543"},"packages/core/src/react/provider/types.ts:543")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"layout"},"layout"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"layout"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Settings related to layout."),(0,r.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contentSize?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the max-width of the content.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"wideSize?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the max-width of wide (",(0,r.kt)("inlineCode",{parentName:"td"},".alignwide"),") content.")))),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L435"},"packages/core/src/react/provider/types.ts:435")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"spacing"},"spacing"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"spacing"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Settings related to spacing."),(0,r.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"blockGap?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Enables ",(0,r.kt)("inlineCode",{parentName:"td"},"--wp--style--block-gap")," to be generated from styles.spacing.blockGap. A value of ",(0,r.kt)("inlineCode",{parentName:"td"},"null")," instead of ",(0,r.kt)("inlineCode",{parentName:"td"},"false")," further disables layout styles from being generated.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set a custom margin.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set a custom padding.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"units?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"List of units the user can use for spacing values.")))),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L448"},"packages/core/src/react/provider/types.ts:448")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"typography"},"typography"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"typography"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Settings related to typography."),(0,r.kt)("h4",{id:"type-declaration-4"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customFontSize?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom font sizes.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"dropCap?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Enable drop cap.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontFamilies?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"fontFamily?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"name?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"slug?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Font family presets for the font family selector. Generates a single custom property (",(0,r.kt)("inlineCode",{parentName:"td"},"--wp--preset--font-family--{slug}"),") per preset value.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontSizes?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"name?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"size?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"slug?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Font size presets for the font size selector. Generates a single class (",(0,r.kt)("inlineCode",{parentName:"td"},".has-{slug}-color"),") and custom property (",(0,r.kt)("inlineCode",{parentName:"td"},"--wp--preset--font-size--{slug}"),") per preset value.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontStyle?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom font styles.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontWeight?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom font weights.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"letterSpacing?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom letter spacing.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"lineHeight?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom line height.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"textDecoration?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom text decorations.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"textTransform?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom text transforms.")))),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L470"},"packages/core/src/react/provider/types.ts:470")))}m.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1247],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>N});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),d=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},s=function(e){var t=d(e.components);return n.createElement(p.Provider,{value:t},e.children)},m="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},c=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,p=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),m=d(a),c=r,N=m["".concat(p,".").concat(c)]||m[c]||k[c]||l;return a?n.createElement(N,i(i({ref:t},s),{},{components:a})):n.createElement(N,i({ref:t},s))}));function N(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,i=new Array(l);i[0]=c;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[m]="string"==typeof e?e:r,i[1]=o;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>m,frontMatter:()=>l,metadata:()=>o,toc:()=>d});var n=a(7462),r=(a(7294),a(3905));const l={id:"headstartwp_core.react.SettingsProperties",title:"Interface: SettingsProperties",sidebar_label:"@headstartwp/core.react.SettingsProperties",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.SettingsProperties",id:"interfaces/headstartwp_core.react.SettingsProperties",title:"Interface: SettingsProperties",description:"@headstartwp/core.react.SettingsProperties",source:"@site/docs/interfaces/headstartwp_core.react.SettingsProperties.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.SettingsProperties",permalink:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.SettingsProperties",title:"Interface: SettingsProperties",sidebar_label:"@headstartwp/core.react.SettingsProperties",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.SettingsCustomAdditionalProperties",permalink:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties"},next:{title:"@headstartwp/core.react.SpacerBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps"}},p={},d=[{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"appearanceTools",id:"appearancetools",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"border",id:"border",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"color",id:"color",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"custom",id:"custom",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"layout",id:"layout",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"spacing",id:"spacing",level:3},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"typography",id:"typography",level:3},{value:"Type declaration",id:"type-declaration-4",level:4},{value:"Defined in",id:"defined-in-6",level:4}],s={toc:d};function m(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".SettingsProperties"),(0,r.kt)("h2",{id:"indexable"},"Indexable"),(0,r.kt)("p",null,"\u25aa ","[k: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"appearancetools"},"appearanceTools"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"appearanceTools"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Setting that enables ui tools."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L358"},"packages/core/src/react/provider/types.ts:358")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"border"},"border"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"border"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Settings related to borders."),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"color?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom border colors.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"radius?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom border radius.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"style?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom border styles.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"width?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom border widths.")))),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L362"},"packages/core/src/react/provider/types.ts:362")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"color"},"color"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"color"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Settings related to colors."),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"background?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set background colors.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"custom?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to select custom colors.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customDuotone?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to create custom duotone filters.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customGradient?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to create custom gradients.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"defaultGradients?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to choose colors from the default gradients.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"defaultPalette?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to choose colors from the default palette.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"duotone?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsduotone"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsDuotone"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Duotone presets for the duotone picker. Doesn't generate classes or properties.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"gradients?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsgradient"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsGradient"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Gradient presets for the gradient picker. Generates a single class (",(0,r.kt)("inlineCode",{parentName:"td"},".has-{slug}-background"),") and custom property (",(0,r.kt)("inlineCode",{parentName:"td"},"--wp--preset--gradient--{slug}"),") per preset value.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"link?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set link colors.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"palette?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingscolorpalette"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsColorPalette"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Color palette presets for the color picker. Generates three classes (",(0,r.kt)("inlineCode",{parentName:"td"},".has-{slug}-color"),", ",(0,r.kt)("inlineCode",{parentName:"td"},".has-{slug}-background-color"),", and ",(0,r.kt)("inlineCode",{parentName:"td"},".has-{slug}-border-color"),") and a single custom property (",(0,r.kt)("inlineCode",{parentName:"td"},"--wp--preset--color--{slug}"),") per preset value.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"text?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set text colors.")))),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L383"},"packages/core/src/react/provider/types.ts:383")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"custom"},"custom"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"custom"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Generate custom CSS custom properties of the form ",(0,r.kt)("inlineCode",{parentName:"p"},"--wp--custom--{key}--{nested-key}: {value};"),". ",(0,r.kt)("inlineCode",{parentName:"p"},"camelCased")," keys are transformed to ",(0,r.kt)("inlineCode",{parentName:"p"},"kebab-case")," as to follow the CSS property naming schema. Keys at different depth levels are separated by ",(0,r.kt)("inlineCode",{parentName:"p"},"--"),", so keys should not include ",(0,r.kt)("inlineCode",{parentName:"p"},"--")," in the name."),(0,r.kt)("h4",{id:"index-signature"},"Index signature"),(0,r.kt)("p",null,"\u25aa ","[k: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsCustomAdditionalProperties"))),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L543"},"packages/core/src/react/provider/types.ts:543")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"layout"},"layout"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"layout"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Settings related to layout."),(0,r.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"contentSize?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the max-width of the content.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"wideSize?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the max-width of wide (",(0,r.kt)("inlineCode",{parentName:"td"},".alignwide"),") content.")))),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L435"},"packages/core/src/react/provider/types.ts:435")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"spacing"},"spacing"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"spacing"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Settings related to spacing."),(0,r.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"blockGap?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Enables ",(0,r.kt)("inlineCode",{parentName:"td"},"--wp--style--block-gap")," to be generated from styles.spacing.blockGap. A value of ",(0,r.kt)("inlineCode",{parentName:"td"},"null")," instead of ",(0,r.kt)("inlineCode",{parentName:"td"},"false")," further disables layout styles from being generated.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set a custom margin.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set a custom padding.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"units?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"List of units the user can use for spacing values.")))),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L448"},"packages/core/src/react/provider/types.ts:448")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"typography"},"typography"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"typography"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Settings related to typography."),(0,r.kt)("h4",{id:"type-declaration-4"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"customFontSize?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom font sizes.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"dropCap?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Enable drop cap.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontFamilies?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"fontFamily?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"name?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"slug?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Font family presets for the font family selector. Generates a single custom property (",(0,r.kt)("inlineCode",{parentName:"td"},"--wp--preset--font-family--{slug}"),") per preset value.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontSizes?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"name?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"size?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"slug?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Font size presets for the font size selector. Generates a single class (",(0,r.kt)("inlineCode",{parentName:"td"},".has-{slug}-color"),") and custom property (",(0,r.kt)("inlineCode",{parentName:"td"},"--wp--preset--font-size--{slug}"),") per preset value.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontStyle?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom font styles.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontWeight?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom font weights.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"letterSpacing?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom letter spacing.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"lineHeight?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom line height.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"textDecoration?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom text decorations.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"textTransform?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Allow users to set custom text transforms.")))),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L470"},"packages/core/src/react/provider/types.ts:470")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/15509991.b3a2e18f.js b/assets/js/15509991.0ed7897f.js similarity index 99% rename from assets/js/15509991.b3a2e18f.js rename to assets/js/15509991.0ed7897f.js index 303db2790..1bbdb2153 100644 --- a/assets/js/15509991.b3a2e18f.js +++ b/assets/js/15509991.0ed7897f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1425],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>m});var o=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var l=o.createContext({}),p=function(e){var t=o.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},d=function(e){var t=p(e.components);return o.createElement(l.Provider,{value:t},e.children)},u="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},c=o.forwardRef((function(e,t){var n=e.components,r=e.mdxType,a=e.originalType,l=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),u=p(n),c=r,m=u["".concat(l,".").concat(c)]||u[c]||h[c]||a;return n?o.createElement(m,s(s({ref:t},d),{},{components:n})):o.createElement(m,s({ref:t},d))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var a=n.length,s=new Array(a);s[0]=c;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[u]="string"==typeof e?e:r,s[1]=i;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>u,frontMatter:()=>a,metadata:()=>i,toc:()=>p});var o=n(7462),r=(n(7294),n(3905));const a={slug:"/getting-started/headless-config",sidebar_position:3},s="Configuring the Framework",i={unversionedId:"Getting Started/headless-config",id:"Getting Started/headless-config",title:"Configuring the Framework",description:"The headstartwp.config.js (previously, headless.config.js) file contains several config options for HeadstartWP. This file should export an object of type HeadlessConfig.",source:"@site/documentation/01-Getting Started/headless-config.md",sourceDirName:"01-Getting Started",slug:"/getting-started/headless-config",permalink:"/docs/learn/getting-started/headless-config",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/01-Getting Started/headless-config.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",sidebarPosition:3,frontMatter:{slug:"/getting-started/headless-config",sidebar_position:3},sidebar:"tutorialSidebar",previous:{title:"Setting up the framework from scratch",permalink:"/docs/learn/getting-started/setting-up-manually"},next:{title:"Installing WordPress Plugin",permalink:"/docs/learn/getting-started/installing-wordpress-plugin"}},l={},p=[{value:"Usage with Next.js",id:"usage-with-nextjs",level:2},{value:"sourceUrl",id:"sourceurl",level:2},{value:"useWordPressPlugin",id:"usewordpressplugin",level:2},{value:"hostUrl",id:"hosturl",level:2},{value:"host",id:"host",level:2},{value:"customPostTypes",id:"customposttypes",level:2},{value:"customTaxonomies",id:"customtaxonomies",level:2},{value:"restParam",id:"restparam",level:3},{value:"rewrite",id:"rewrite",level:3},{value:"redirectStrategy",id:"redirectstrategy",level:2},{value:"debug",id:"debug",level:2},{value:"preview",id:"preview",level:2},{value:"alternativeAuthorizationHeader",id:"alternativeauthorizationheader",level:3},{value:"usePostLinkForRedirect",id:"usepostlinkforredirect",level:3}],d={toc:p};function u(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,o.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"configuring-the-framework"},"Configuring the Framework"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," (previously, ",(0,r.kt)("inlineCode",{parentName:"p"},"headless.config.js"),") file contains several config options for HeadstartWP. This file should export an object of type ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_core/#headlessconfig"},"HeadlessConfig"),"."),(0,r.kt)("h2",{id:"usage-with-nextjs"},"Usage with Next.js"),(0,r.kt)("p",null,"The file ",(0,r.kt)("strong",{parentName:"p"},"must be named")," either ",(0,r.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"headless.config.js"),". When ",(0,r.kt)("inlineCode",{parentName:"p"},"injectConfig")," param of ",(0,r.kt)("inlineCode",{parentName:"p"},"withHeadstartWPConfig")," (previously ",(0,r.kt)("inlineCode",{parentName:"p"},"withHeadlessConfig"),") is set to true, the framework will look for these two files to be injected and loaded in the runtime bundle of the Next.js App."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=next.config.js",title:"next.config.js"},"const { withHeadstartWPConfig } = require('@headstartwp/next/config');\n\n/**\n * Update whatever you need within the nextConfig object.\n *\n * @type {import('next').NextConfig}\n */\nconst nextConfig = {};\n\nmodule.exports = withHeadstartWPConfig(nextConfig);\n")),(0,r.kt)("admonition",{type:"caution"},(0,r.kt)("p",{parentName:"admonition"},"Since ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/next@1.2.0")," you do not need to import ",(0,r.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," in ",(0,r.kt)("inlineCode",{parentName:"p"},"next.config.js")," anymore, the framework will dynamically load the config.")),(0,r.kt)("p",null,"Here's a sample config file"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"module.exports = {\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,\n hostUrl: process.env.HOST_URL,\n customPostTypes: [],\n customTaxonomies: [],\n redirectStrategy: '404',\n useWordPressPlugin: true,\n debug: {\n redirects: false,\n requests: false,\n }\n};\n")),(0,r.kt)("h2",{id:"sourceurl"},"sourceUrl"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl")," option should point to a valid WordPress installation from where the headless site should be sourced to."),(0,r.kt)("h2",{id:"usewordpressplugin"},"useWordPressPlugin"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"useWordPressPlugin")," indicates whether the WordPress instance at ",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl")," contains the Headless WordPress plugin. While it is possible to use this framework without the plugin, it is strongly recommended to install the WP plugin and set this option to true."),(0,r.kt)("h2",{id:"hosturl"},"hostUrl"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"hostUrl")," option should contain the value where the frontend app lives. This would typically be the public domain of the site."),(0,r.kt)("h2",{id:"host"},"host"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"host")," option is automatically inferred if ",(0,r.kt)("inlineCode",{parentName:"p"},"hostUrl")," is set. You probably don't need to set this option by yourself. The ",(0,r.kt)("inlineCode",{parentName:"p"},"host")," value is used by the multisite feature to match the current site to a site config."),(0,r.kt)("h2",{id:"customposttypes"},"customPostTypes"),(0,r.kt)("p",null,"To add support for custom post types, add your custom post type to the ",(0,r.kt)("inlineCode",{parentName:"p"},"customPostTypes")," setting in ",(0,r.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js"),"."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"module.exports = {\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,\n hostUrl: process.env.HOST_URL,\n customPostTypes: [\n {\n slug: 'book',\n endpoint: '/wp-json/wp/v2/book',\n // these should match your file-system routing\n single: '/book',\n archive: '/books',\n },\n ],\n}\n")),(0,r.kt)("p",null,"After adding a custom post type to the config, you will be able to fetch posts from the registered post type via the slug:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"usePost({ postType: ['book'] });\nusePosts({ postType:'book', perPage: 10 });\n")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"single")," option is required for several things including:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},'properly previewing custom post types when the "single" route is at a different prefix. E.g: ',(0,r.kt)("inlineCode",{parentName:"li"},"/book/da-vince-code")," instead of ",(0,r.kt)("inlineCode",{parentName:"li"},"/da-vice-code"),"; In this case, the framework will use the ",(0,r.kt)("inlineCode",{parentName:"li"},"single")," path to redirect the previewed post to the right path/route."),(0,r.kt)("li",{parentName:"ul"},"Matching post path permalinks with the current URL. E.g: when fetching a single custom post type the framework will filter the returned posts to the one that matches the existing URL. Therefore, the framework needs to know the single prefix url for custom post types. This is required to properly handle parent pages that share the same child slug. See ",(0,r.kt)("a",{parentName:"li",href:"/learn/data-fetching/usepost/#post-path-matching"},"post path mapping")," for more info.")),(0,r.kt)("p",null,"It is also possible to pass a function, when doing so the default post types (post and pages) will be passed to the function. The code snipped below will disable ",(0,r.kt)("a",{parentName:"p",href:"/learn/data-fetching/usepost/#post-path-matching"},"post path mapping")," to the default post types."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"module.exports = {\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,\n hostUrl: process.env.HOST_URL,\n customPostTypes: (defaultPostTypes) => {\n // disable post path mapping for default post types\n return defaultPostTypes.map((postType) => ({...postType, matchSinglePath: false}));\n }\n}\n")),(0,r.kt)("h2",{id:"customtaxonomies"},"customTaxonomies"),(0,r.kt)("p",null,"To add support for custom taxonomies, add your custom taxonomy to the ",(0,r.kt)("inlineCode",{parentName:"p"},"customTaxonomies")," setting in ",(0,r.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js"),"."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"module.exports = {\n customPostTypes: [\n {\n slug: 'book',\n endpoint: '/wp-json/wp/v2/book',\n // these should match your file-system routing\n single: '/book',\n archive: '/books',\n },\n ],\n customTaxonomies: [\n { \n slug: 'genre',\n endpoint: '/wp-json/wp/v2/genre',\n postType: ['book'],\n rewrite: 'genre',\n restParam: 'genre'\n },\n ],\n}\n")),(0,r.kt)("p",null,"After adding a custom taxonomy to the config, you will be able to filter posts by the registered taxonomy or fetch terms from it."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"usePost({ postType: ['book'], genre: 'action' });\nusePosts({ postType:'book', genre: 'action', perPage: 10 });\nuseTerms({ taxonomy: 'genre' });\n")),(0,r.kt)("p",null,"Additionally, if you have an archive route such as ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"/books")," filtering for all registered taxonomies works out of the box. For instance, take the headless config above the following page route:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/pages/books/[[...path]].js",title:"src/pages/books/[[...path]].js"},"import { usePosts } from '@headstartwp/next';\nconst BooksPage = () => {\n const { data, error, loading } = usePosts({postType: 'book'});\n\n if (error) {\n return 'error';\n }\n\n if (loading) {\n return 'Loading...';\n }\n\n return (\n
    \n {data.posts.map((post) => (\n
  • {post.title.rendered}
    • \n ))}\n
\n );\n};\n\nexport default BooksPage;\n")),(0,r.kt)("p",null,"This route would automatically handle the following URLs:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"/books -> list latest books"),(0,r.kt)("li",{parentName:"ul"},"/books/page/x -> paginate books"),(0,r.kt)("li",{parentName:"ul"},"/books/genre/genre-name -> filter books by genre"),(0,r.kt)("li",{parentName:"ul"},"/books/genre/genre-name/page/2 -> paginate books filtered by genre")),(0,r.kt)("admonition",{type:"caution"},(0,r.kt)("p",{parentName:"admonition"},"The code snippet above does not implement pre-fetching, which you probably want to. Check out the ",(0,r.kt)("a",{parentName:"p",href:"/learn/data-fetching/prefetching"},"pre-fetching docs")," for instructions.")),(0,r.kt)("p",null,"It is also possible to specify a function for 'customTaxonomies', when doing so the default taxonomies will be passed to the function. This can be used for instance to enable ",(0,r.kt)("a",{parentName:"p",href:"/learn/data-fetching/useposts#archive-path-matching"},"archive path matching"),"."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"module.exports = {\n customPostTypes: [\n {\n slug: 'book',\n endpoint: '/wp-json/wp/v2/book',\n // these should match your file-system routing\n single: '/book',\n archive: '/books',\n },\n ],\n customTaxonomies: (defaultTaxonomies) => {\n return defaultTaxonomies.map((taxonomy) => ({ ...taxonomy, matchArchivePath: true })),\n },\n}\n")),(0,r.kt)("h3",{id:"restparam"},"restParam"),(0,r.kt)("p",null,"This option shouldn't be necessary most of the time, but this is used to map a custom taxonomy to its REST API parameter. Most of the times the slug is equal to the restParam but in some cases it differs. For instance, the default post tag taxonomy has a slug of ",(0,r.kt)("inlineCode",{parentName:"p"},"post_tag")," but a ",(0,r.kt)("inlineCode",{parentName:"p"},"restParam")," of ",(0,r.kt)("inlineCode",{parentName:"p"},"tags")," (i.e., to filter posts by ",(0,r.kt)("inlineCode",{parentName:"p"},"tags")," in the REST API, we must use ",(0,r.kt)("inlineCode",{parentName:"p"},"tags="),")."),(0,r.kt)("h3",{id:"rewrite"},"rewrite"),(0,r.kt)("p",null,"This option controls the expected prefix the taxonomy must use in front-end urls. This generally should match ",(0,r.kt)("inlineCode",{parentName:"p"},"rewrite.slug")," of the ",(0,r.kt)("a",{parentName:"p",href:"https://developer.wordpress.org/reference/functions/register_taxonomy/"},"register_taxonomy")," function."),(0,r.kt)("h2",{id:"redirectstrategy"},"redirectStrategy"),(0,r.kt)("p",null,"This option control how redirects are handled. There are 2 supported methods of handling redirects."),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"404: If a route 404, the framework will check to see if there's a redirect for that page in WP. If so it performs the redirect. This is the recommended option."),(0,r.kt)("li",{parentName:"ul"},"always: When this option is set, the framework will ",(0,r.kt)("strong",{parentName:"li"},"always")," check for redirects before rendering any page. Using this option carefully since it will impact performance.")),(0,r.kt)("h2",{id:"debug"},"debug"),(0,r.kt)("p",null,"You can enable log debugging for both requests and redirects. ",(0,r.kt)("inlineCode",{parentName:"p"},"debug.requests")," will enable logging all API requests made by the framework and ",(0,r.kt)("inlineCode",{parentName:"p"},"debug.redirects")," will log all attempts to detect and fetch a redirect from WordPress."),(0,r.kt)("h2",{id:"preview"},"preview"),(0,r.kt)("h3",{id:"alternativeauthorizationheader"},"alternativeAuthorizationHeader"),(0,r.kt)("p",null,"Tells HeadstartWP to use an alternative header (",(0,r.kt)("inlineCode",{parentName:"p"},"X-HeadstartWP-Authorization"),") instead of the default ",(0,r.kt)("inlineCode",{parentName:"p"},"Authorization")," header for making authenticated preview requests."),(0,r.kt)("p",null,"Make sure you have HeadstartWP plugin >= 1.0.1, ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/core")," >= 1.3.1 and ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/next"),">= 1.3.1 to use this setting."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"module.exports = {\n // other configs.\n // ...\n\n preview: {\n alternativeAuthorizationHeader: true\n }\n}\n")),(0,r.kt)("h3",{id:"usepostlinkforredirect"},"usePostLinkForRedirect"),(0,r.kt)("admonition",{type:"info"},(0,r.kt)("p",{parentName:"admonition"},"This feature was added in ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/next@1.3.3")," and requires the plugin version >= 1.1.2.")),(0,r.kt)("p",null,"This option, if enabled, will use the ",(0,r.kt)("inlineCode",{parentName:"p"},"post.link")," property of the post being previewed to redirect to the appropriate route for previewing. This can be very useful to avoid the need for providing a custom ",(0,r.kt)("a",{parentName:"p",href:"/learn/wordpress-integration/previews#getredirectpath"},"getRedirectPath")," implementation by telling the preview handler to simply use the post's link as returned via the WordPress ",(0,r.kt)("inlineCode",{parentName:"p"},"get_permalink")," function."),(0,r.kt)("p",null,"Note that you will want to make sure that your WordPress permalink structure closely follows the route structure of your Next.js app for this option to work well."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"module.exports = {\n // other configs.\n // ...\n\n preview: {\n usePostLinkForRedirect: true\n }\n}\n")),(0,r.kt)("p",null,"More for info check out the ",(0,r.kt)("a",{parentName:"p",href:"/learn/wordpress-integration/previews#the-usepostlinkforredirect-setting"},"preview docs"),"."))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1425],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>m});var o=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var l=o.createContext({}),p=function(e){var t=o.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},d=function(e){var t=p(e.components);return o.createElement(l.Provider,{value:t},e.children)},u="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},c=o.forwardRef((function(e,t){var n=e.components,r=e.mdxType,a=e.originalType,l=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),u=p(n),c=r,m=u["".concat(l,".").concat(c)]||u[c]||h[c]||a;return n?o.createElement(m,s(s({ref:t},d),{},{components:n})):o.createElement(m,s({ref:t},d))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var a=n.length,s=new Array(a);s[0]=c;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[u]="string"==typeof e?e:r,s[1]=i;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>u,frontMatter:()=>a,metadata:()=>i,toc:()=>p});var o=n(7462),r=(n(7294),n(3905));const a={slug:"/getting-started/headless-config",sidebar_position:3},s="Configuring the Framework",i={unversionedId:"Getting Started/headless-config",id:"Getting Started/headless-config",title:"Configuring the Framework",description:"The headstartwp.config.js (previously, headless.config.js) file contains several config options for HeadstartWP. This file should export an object of type HeadlessConfig.",source:"@site/documentation/01-Getting Started/headless-config.md",sourceDirName:"01-Getting Started",slug:"/getting-started/headless-config",permalink:"/docs/learn/getting-started/headless-config",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/01-Getting Started/headless-config.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",sidebarPosition:3,frontMatter:{slug:"/getting-started/headless-config",sidebar_position:3},sidebar:"tutorialSidebar",previous:{title:"Setting up the framework from scratch",permalink:"/docs/learn/getting-started/setting-up-manually"},next:{title:"Installing WordPress Plugin",permalink:"/docs/learn/getting-started/installing-wordpress-plugin"}},l={},p=[{value:"Usage with Next.js",id:"usage-with-nextjs",level:2},{value:"sourceUrl",id:"sourceurl",level:2},{value:"useWordPressPlugin",id:"usewordpressplugin",level:2},{value:"hostUrl",id:"hosturl",level:2},{value:"host",id:"host",level:2},{value:"customPostTypes",id:"customposttypes",level:2},{value:"customTaxonomies",id:"customtaxonomies",level:2},{value:"restParam",id:"restparam",level:3},{value:"rewrite",id:"rewrite",level:3},{value:"redirectStrategy",id:"redirectstrategy",level:2},{value:"debug",id:"debug",level:2},{value:"preview",id:"preview",level:2},{value:"alternativeAuthorizationHeader",id:"alternativeauthorizationheader",level:3},{value:"usePostLinkForRedirect",id:"usepostlinkforredirect",level:3}],d={toc:p};function u(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,o.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"configuring-the-framework"},"Configuring the Framework"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," (previously, ",(0,r.kt)("inlineCode",{parentName:"p"},"headless.config.js"),") file contains several config options for HeadstartWP. This file should export an object of type ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_core/#headlessconfig"},"HeadlessConfig"),"."),(0,r.kt)("h2",{id:"usage-with-nextjs"},"Usage with Next.js"),(0,r.kt)("p",null,"The file ",(0,r.kt)("strong",{parentName:"p"},"must be named")," either ",(0,r.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"headless.config.js"),". When ",(0,r.kt)("inlineCode",{parentName:"p"},"injectConfig")," param of ",(0,r.kt)("inlineCode",{parentName:"p"},"withHeadstartWPConfig")," (previously ",(0,r.kt)("inlineCode",{parentName:"p"},"withHeadlessConfig"),") is set to true, the framework will look for these two files to be injected and loaded in the runtime bundle of the Next.js App."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=next.config.js",title:"next.config.js"},"const { withHeadstartWPConfig } = require('@headstartwp/next/config');\n\n/**\n * Update whatever you need within the nextConfig object.\n *\n * @type {import('next').NextConfig}\n */\nconst nextConfig = {};\n\nmodule.exports = withHeadstartWPConfig(nextConfig);\n")),(0,r.kt)("admonition",{type:"caution"},(0,r.kt)("p",{parentName:"admonition"},"Since ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/next@1.2.0")," you do not need to import ",(0,r.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," in ",(0,r.kt)("inlineCode",{parentName:"p"},"next.config.js")," anymore, the framework will dynamically load the config.")),(0,r.kt)("p",null,"Here's a sample config file"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"module.exports = {\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,\n hostUrl: process.env.HOST_URL,\n customPostTypes: [],\n customTaxonomies: [],\n redirectStrategy: '404',\n useWordPressPlugin: true,\n debug: {\n redirects: false,\n requests: false,\n }\n};\n")),(0,r.kt)("h2",{id:"sourceurl"},"sourceUrl"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl")," option should point to a valid WordPress installation from where the headless site should be sourced to."),(0,r.kt)("h2",{id:"usewordpressplugin"},"useWordPressPlugin"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"useWordPressPlugin")," indicates whether the WordPress instance at ",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl")," contains the Headless WordPress plugin. While it is possible to use this framework without the plugin, it is strongly recommended to install the WP plugin and set this option to true."),(0,r.kt)("h2",{id:"hosturl"},"hostUrl"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"hostUrl")," option should contain the value where the frontend app lives. This would typically be the public domain of the site."),(0,r.kt)("h2",{id:"host"},"host"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"host")," option is automatically inferred if ",(0,r.kt)("inlineCode",{parentName:"p"},"hostUrl")," is set. You probably don't need to set this option by yourself. The ",(0,r.kt)("inlineCode",{parentName:"p"},"host")," value is used by the multisite feature to match the current site to a site config."),(0,r.kt)("h2",{id:"customposttypes"},"customPostTypes"),(0,r.kt)("p",null,"To add support for custom post types, add your custom post type to the ",(0,r.kt)("inlineCode",{parentName:"p"},"customPostTypes")," setting in ",(0,r.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js"),"."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"module.exports = {\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,\n hostUrl: process.env.HOST_URL,\n customPostTypes: [\n {\n slug: 'book',\n endpoint: '/wp-json/wp/v2/book',\n // these should match your file-system routing\n single: '/book',\n archive: '/books',\n },\n ],\n}\n")),(0,r.kt)("p",null,"After adding a custom post type to the config, you will be able to fetch posts from the registered post type via the slug:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"usePost({ postType: ['book'] });\nusePosts({ postType:'book', perPage: 10 });\n")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"single")," option is required for several things including:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},'properly previewing custom post types when the "single" route is at a different prefix. E.g: ',(0,r.kt)("inlineCode",{parentName:"li"},"/book/da-vince-code")," instead of ",(0,r.kt)("inlineCode",{parentName:"li"},"/da-vice-code"),"; In this case, the framework will use the ",(0,r.kt)("inlineCode",{parentName:"li"},"single")," path to redirect the previewed post to the right path/route."),(0,r.kt)("li",{parentName:"ul"},"Matching post path permalinks with the current URL. E.g: when fetching a single custom post type the framework will filter the returned posts to the one that matches the existing URL. Therefore, the framework needs to know the single prefix url for custom post types. This is required to properly handle parent pages that share the same child slug. See ",(0,r.kt)("a",{parentName:"li",href:"/learn/data-fetching/usepost/#post-path-matching"},"post path mapping")," for more info.")),(0,r.kt)("p",null,"It is also possible to pass a function, when doing so the default post types (post and pages) will be passed to the function. The code snipped below will disable ",(0,r.kt)("a",{parentName:"p",href:"/learn/data-fetching/usepost/#post-path-matching"},"post path mapping")," to the default post types."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"module.exports = {\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,\n hostUrl: process.env.HOST_URL,\n customPostTypes: (defaultPostTypes) => {\n // disable post path mapping for default post types\n return defaultPostTypes.map((postType) => ({...postType, matchSinglePath: false}));\n }\n}\n")),(0,r.kt)("h2",{id:"customtaxonomies"},"customTaxonomies"),(0,r.kt)("p",null,"To add support for custom taxonomies, add your custom taxonomy to the ",(0,r.kt)("inlineCode",{parentName:"p"},"customTaxonomies")," setting in ",(0,r.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js"),"."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"module.exports = {\n customPostTypes: [\n {\n slug: 'book',\n endpoint: '/wp-json/wp/v2/book',\n // these should match your file-system routing\n single: '/book',\n archive: '/books',\n },\n ],\n customTaxonomies: [\n { \n slug: 'genre',\n endpoint: '/wp-json/wp/v2/genre',\n postType: ['book'],\n rewrite: 'genre',\n restParam: 'genre'\n },\n ],\n}\n")),(0,r.kt)("p",null,"After adding a custom taxonomy to the config, you will be able to filter posts by the registered taxonomy or fetch terms from it."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"usePost({ postType: ['book'], genre: 'action' });\nusePosts({ postType:'book', genre: 'action', perPage: 10 });\nuseTerms({ taxonomy: 'genre' });\n")),(0,r.kt)("p",null,"Additionally, if you have an archive route such as ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"/books")," filtering for all registered taxonomies works out of the box. For instance, take the headless config above the following page route:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/pages/books/[[...path]].js",title:"src/pages/books/[[...path]].js"},"import { usePosts } from '@headstartwp/next';\nconst BooksPage = () => {\n const { data, error, loading } = usePosts({postType: 'book'});\n\n if (error) {\n return 'error';\n }\n\n if (loading) {\n return 'Loading...';\n }\n\n return (\n
    \n {data.posts.map((post) => (\n
  • {post.title.rendered}
    • \n ))}\n
\n );\n};\n\nexport default BooksPage;\n")),(0,r.kt)("p",null,"This route would automatically handle the following URLs:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"/books -> list latest books"),(0,r.kt)("li",{parentName:"ul"},"/books/page/x -> paginate books"),(0,r.kt)("li",{parentName:"ul"},"/books/genre/genre-name -> filter books by genre"),(0,r.kt)("li",{parentName:"ul"},"/books/genre/genre-name/page/2 -> paginate books filtered by genre")),(0,r.kt)("admonition",{type:"caution"},(0,r.kt)("p",{parentName:"admonition"},"The code snippet above does not implement pre-fetching, which you probably want to. Check out the ",(0,r.kt)("a",{parentName:"p",href:"/learn/data-fetching/prefetching"},"pre-fetching docs")," for instructions.")),(0,r.kt)("p",null,"It is also possible to specify a function for 'customTaxonomies', when doing so the default taxonomies will be passed to the function. This can be used for instance to enable ",(0,r.kt)("a",{parentName:"p",href:"/learn/data-fetching/useposts#archive-path-matching"},"archive path matching"),"."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"module.exports = {\n customPostTypes: [\n {\n slug: 'book',\n endpoint: '/wp-json/wp/v2/book',\n // these should match your file-system routing\n single: '/book',\n archive: '/books',\n },\n ],\n customTaxonomies: (defaultTaxonomies) => {\n return defaultTaxonomies.map((taxonomy) => ({ ...taxonomy, matchArchivePath: true })),\n },\n}\n")),(0,r.kt)("h3",{id:"restparam"},"restParam"),(0,r.kt)("p",null,"This option shouldn't be necessary most of the time, but this is used to map a custom taxonomy to its REST API parameter. Most of the times the slug is equal to the restParam but in some cases it differs. For instance, the default post tag taxonomy has a slug of ",(0,r.kt)("inlineCode",{parentName:"p"},"post_tag")," but a ",(0,r.kt)("inlineCode",{parentName:"p"},"restParam")," of ",(0,r.kt)("inlineCode",{parentName:"p"},"tags")," (i.e., to filter posts by ",(0,r.kt)("inlineCode",{parentName:"p"},"tags")," in the REST API, we must use ",(0,r.kt)("inlineCode",{parentName:"p"},"tags="),")."),(0,r.kt)("h3",{id:"rewrite"},"rewrite"),(0,r.kt)("p",null,"This option controls the expected prefix the taxonomy must use in front-end urls. This generally should match ",(0,r.kt)("inlineCode",{parentName:"p"},"rewrite.slug")," of the ",(0,r.kt)("a",{parentName:"p",href:"https://developer.wordpress.org/reference/functions/register_taxonomy/"},"register_taxonomy")," function."),(0,r.kt)("h2",{id:"redirectstrategy"},"redirectStrategy"),(0,r.kt)("p",null,"This option control how redirects are handled. There are 2 supported methods of handling redirects."),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"404: If a route 404, the framework will check to see if there's a redirect for that page in WP. If so it performs the redirect. This is the recommended option."),(0,r.kt)("li",{parentName:"ul"},"always: When this option is set, the framework will ",(0,r.kt)("strong",{parentName:"li"},"always")," check for redirects before rendering any page. Using this option carefully since it will impact performance.")),(0,r.kt)("h2",{id:"debug"},"debug"),(0,r.kt)("p",null,"You can enable log debugging for both requests and redirects. ",(0,r.kt)("inlineCode",{parentName:"p"},"debug.requests")," will enable logging all API requests made by the framework and ",(0,r.kt)("inlineCode",{parentName:"p"},"debug.redirects")," will log all attempts to detect and fetch a redirect from WordPress."),(0,r.kt)("h2",{id:"preview"},"preview"),(0,r.kt)("h3",{id:"alternativeauthorizationheader"},"alternativeAuthorizationHeader"),(0,r.kt)("p",null,"Tells HeadstartWP to use an alternative header (",(0,r.kt)("inlineCode",{parentName:"p"},"X-HeadstartWP-Authorization"),") instead of the default ",(0,r.kt)("inlineCode",{parentName:"p"},"Authorization")," header for making authenticated preview requests."),(0,r.kt)("p",null,"Make sure you have HeadstartWP plugin >= 1.0.1, ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/core")," >= 1.3.1 and ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/next"),">= 1.3.1 to use this setting."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"module.exports = {\n // other configs.\n // ...\n\n preview: {\n alternativeAuthorizationHeader: true\n }\n}\n")),(0,r.kt)("h3",{id:"usepostlinkforredirect"},"usePostLinkForRedirect"),(0,r.kt)("admonition",{type:"info"},(0,r.kt)("p",{parentName:"admonition"},"This feature was added in ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/next@1.3.3")," and requires the plugin version >= 1.1.2.")),(0,r.kt)("p",null,"This option, if enabled, will use the ",(0,r.kt)("inlineCode",{parentName:"p"},"post.link")," property of the post being previewed to redirect to the appropriate route for previewing. This can be very useful to avoid the need for providing a custom ",(0,r.kt)("a",{parentName:"p",href:"/learn/wordpress-integration/previews#getredirectpath"},"getRedirectPath")," implementation by telling the preview handler to simply use the post's link as returned via the WordPress ",(0,r.kt)("inlineCode",{parentName:"p"},"get_permalink")," function."),(0,r.kt)("p",null,"Note that you will want to make sure that your WordPress permalink structure closely follows the route structure of your Next.js app for this option to work well."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"module.exports = {\n // other configs.\n // ...\n\n preview: {\n usePostLinkForRedirect: true\n }\n}\n")),(0,r.kt)("p",null,"More for info check out the ",(0,r.kt)("a",{parentName:"p",href:"/learn/wordpress-integration/previews#the-usepostlinkforredirect-setting"},"preview docs"),"."))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/173c930b.fce10dbc.js b/assets/js/173c930b.2af76204.js similarity index 67% rename from assets/js/173c930b.fce10dbc.js rename to assets/js/173c930b.2af76204.js index abb3f52f5..8191d50a0 100644 --- a/assets/js/173c930b.fce10dbc.js +++ b/assets/js/173c930b.2af76204.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3446],{3905:(e,t,o)=>{o.d(t,{Zo:()=>u,kt:()=>d});var n=o(7294);function r(e,t,o){return t in e?Object.defineProperty(e,t,{value:o,enumerable:!0,configurable:!0,writable:!0}):e[t]=o,e}function a(e,t){var o=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),o.push.apply(o,n)}return o}function s(e){for(var t=1;t=0||(r[o]=e[o]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,o)&&(r[o]=e[o])}return r}var i=n.createContext({}),c=function(e){var t=n.useContext(i),o=t;return e&&(o="function"==typeof e?e(t):s(s({},t),e)),o},u=function(e){var t=c(e.components);return n.createElement(i.Provider,{value:t},e.children)},l="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var o=e.components,r=e.mdxType,a=e.originalType,i=e.parentName,u=p(e,["components","mdxType","originalType","parentName"]),l=c(o),m=r,d=l["".concat(i,".").concat(m)]||l[m]||h[m]||a;return o?n.createElement(d,s(s({ref:t},u),{},{components:o})):n.createElement(d,s({ref:t},u))}));function d(e,t){var o=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var a=o.length,s=new Array(a);s[0]=m;var p={};for(var i in t)hasOwnProperty.call(t,i)&&(p[i]=t[i]);p.originalType=e,p[l]="string"==typeof e?e:r,s[1]=p;for(var c=2;c{o.r(t),o.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>l,frontMatter:()=>a,metadata:()=>p,toc:()=>c});var n=o(7462),r=(o(7294),o(3905));const a={slug:"/data-fetching/creating-your-own-custom-hooks",sidebar_label:"Creating your own custom hooks"},s="Custom hooks",p={unversionedId:"Data Fetching/custom-hooks",id:"Data Fetching/custom-hooks",title:"Custom hooks",description:"Sometimes it might be useful to wrap the framework data-fetching hooks into your own hooks.",source:"@site/documentation/02 - Data Fetching/custom-hooks.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/creating-your-own-custom-hooks",permalink:"/docs/learn/data-fetching/creating-your-own-custom-hooks",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/custom-hooks.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",frontMatter:{slug:"/data-fetching/creating-your-own-custom-hooks",sidebar_label:"Creating your own custom hooks"},sidebar:"tutorialSidebar",previous:{title:"The useSeo hook",permalink:"/docs/learn/data-fetching/useSeo"},next:{title:"Prefetching data on the server",permalink:"/docs/learn/data-fetching/prefetching"}},i={},c=[{value:"Creating a custom hook for a custom post type",id:"creating-a-custom-hook-for-a-custom-post-type",level:2},{value:"Creating your own AppSettings hook",id:"creating-your-own-appsettings-hook",level:2},{value:"Custom Strategies",id:"custom-strategies",level:2}],u={toc:c};function l(e){let{components:t,...o}=e;return(0,r.kt)("wrapper",(0,n.Z)({},u,o,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"custom-hooks"},"Custom hooks"),(0,r.kt)("p",null,"Sometimes it might be useful to wrap the framework data-fetching hooks into your own hooks."),(0,r.kt)("h2",{id:"creating-a-custom-hook-for-a-custom-post-type"},"Creating a custom hook for a custom post type"),(0,r.kt)("p",null,"Let's say you have a custom post type and you want to abstract the parameters needed to get that custom post type. You can create your own hook and pass in the required params."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/hooks/useBook.js",title:"src/hooks/useBook.js"},"import { usePost } from '@headstartwp/next';\n\nconst defaultParams = {\n postType: 'book',\n _embed: true,\n};\n\nexport function useBook(params = {}) {\n return usePost({ ...params, ...defaultParams }, options);\n}\n\nuseBook.fetcher = (sourceUrl?: string) => {\n const fetcher = usePost.fetcher(sourceUrl, defaultParams);\n return fetcher;\n};\n")),(0,r.kt)("p",null,"That way, you don't need to keep passing around the ",(0,r.kt)("inlineCode",{parentName:"p"},"defaultParams")," whenever you want to fetch a single book."),(0,r.kt)("p",null,"By wrapping ",(0,r.kt)("inlineCode",{parentName:"p"},"useBook.fetcher")," we can also pass a set of default params to the default ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," fetcher function. This ensures that when you use ",(0,r.kt)("inlineCode",{parentName:"p"},"fetchHookData")," on the server, the data is fetched using the default parameters."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"// no need to manually pass `{ params: { postType: 'book' } }\nconst bookData = await fetchHookData(useBook.fetcher(), context);\n")),(0,r.kt)("p",null,"This is also useful if you're using TypeScript and your custom post type has additional meta fields."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/hooks/useBook.ts",title:"src/hooks/useBook.ts"},"import { usePost } from '@headstartwp/next';\nimport { PostEntity, PostParams } from '@headstartwp/core';\n\nconst defaultParams: PostParams = {\n postType: 'book',\n _embed: true,\n};\n\ninterface Book extends PostEntity {\n isbn: string;\n}\n\nexport function useBook(params: PostParams | {} = {}) {\n return usePost({ ...params, ...defaultParams }, options);\n}\n\nuseBook.fetcher = (sourceUrl?: string) => {\n const fetcher = usePost.fetcher(sourceUrl, defaultParams);\n return fetcher;\n};\n")),(0,r.kt)("p",null,"Then when using the custom hook ",(0,r.kt)("inlineCode",{parentName:"p"},"isbn")," will show up as a property of the returned post objects."),(0,r.kt)("h2",{id:"creating-your-own-appsettings-hook"},"Creating your own AppSettings hook"),(0,r.kt)("p",null,"If you're using TypeScript and you are extending the framework's app endpoint and including new fields, you can create your own custom hook and specify the additional TypeScript types."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/hooks/useMyAppSettings.ts",title:"src/hooks/useMyAppSettings.ts"},"import { FetchResponse, AppEntity, AppSettingsStrategy } from '@headstartwp/core';\nimport { FetchHookOptions } from '@headstartwp/core/react';\nimport { useAppSettings } from '@headstartwp/next';\n\nexport interface MyAppSettings extends AppEntity {\n my_custom_setting: string;\n}\n\nexport function useMyAppSettings(\n options: FetchHookOptions> = {},\n) {\n return useAppSettings({}, options);\n}\n\nuseMyAppSettings.fetcher = (sourceUrl?: string) =>\n new AppSettingsStrategy(sourceUrl);\n")),(0,r.kt)("h2",{id:"custom-strategies"},"Custom Strategies"),(0,r.kt)("p",null,"Depending on what you're doing you might need to create a completely custom Fetch Strategy. A Fetch strategy must extend ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/headstartwp_core.AbstractFetchStrategy/"},"AbstractFetchStrategy")," and it must contain all of the logic needed to fetch the data."),(0,r.kt)("p",null,"If you feel like to need to create a custom strategy check out the ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/tree/develop/packages/core/src/data/strategies"},"default Fetch Strategies")," as well as the ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/tree/develop/packages/core/src/react/hooks"},"hooks")," that implements them."))}l.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3446],{3905:(t,e,o)=>{o.d(e,{Zo:()=>u,kt:()=>d});var n=o(7294);function r(t,e,o){return e in t?Object.defineProperty(t,e,{value:o,enumerable:!0,configurable:!0,writable:!0}):t[e]=o,t}function a(t,e){var o=Object.keys(t);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(t);e&&(n=n.filter((function(e){return Object.getOwnPropertyDescriptor(t,e).enumerable}))),o.push.apply(o,n)}return o}function s(t){for(var e=1;e=0||(r[o]=t[o]);return r}(t,e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(t);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(t,o)&&(r[o]=t[o])}return r}var p=n.createContext({}),c=function(t){var e=n.useContext(p),o=e;return t&&(o="function"==typeof t?t(e):s(s({},e),t)),o},u=function(t){var e=c(t.components);return n.createElement(p.Provider,{value:e},t.children)},l="mdxType",h={inlineCode:"code",wrapper:function(t){var e=t.children;return n.createElement(n.Fragment,{},e)}},m=n.forwardRef((function(t,e){var o=t.components,r=t.mdxType,a=t.originalType,p=t.parentName,u=i(t,["components","mdxType","originalType","parentName"]),l=c(o),m=r,d=l["".concat(p,".").concat(m)]||l[m]||h[m]||a;return o?n.createElement(d,s(s({ref:e},u),{},{components:o})):n.createElement(d,s({ref:e},u))}));function d(t,e){var o=arguments,r=e&&e.mdxType;if("string"==typeof t||r){var a=o.length,s=new Array(a);s[0]=m;var i={};for(var p in e)hasOwnProperty.call(e,p)&&(i[p]=e[p]);i.originalType=t,i[l]="string"==typeof t?t:r,s[1]=i;for(var c=2;c{o.r(e),o.d(e,{assets:()=>p,contentTitle:()=>s,default:()=>l,frontMatter:()=>a,metadata:()=>i,toc:()=>c});var n=o(7462),r=(o(7294),o(3905));const a={slug:"/data-fetching/creating-your-own-custom-hooks",sidebar_label:"Creating your own custom hooks"},s="Custom hooks",i={unversionedId:"Data Fetching/custom-hooks",id:"Data Fetching/custom-hooks",title:"Custom hooks",description:"Sometimes it might be useful to wrap the framework data-fetching hooks into your own hooks.",source:"@site/documentation/02 - Data Fetching/custom-hooks.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/creating-your-own-custom-hooks",permalink:"/docs/learn/data-fetching/creating-your-own-custom-hooks",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/custom-hooks.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",frontMatter:{slug:"/data-fetching/creating-your-own-custom-hooks",sidebar_label:"Creating your own custom hooks"},sidebar:"tutorialSidebar",previous:{title:"Mutating Data",permalink:"/docs/learn/data-fetching/mutating"},next:{title:"Prefetching data on the server",permalink:"/docs/learn/data-fetching/prefetching"}},p={},c=[{value:"Creating a custom hook for a custom post type",id:"creating-a-custom-hook-for-a-custom-post-type",level:2},{value:"Creating your own AppSettings hook",id:"creating-your-own-appsettings-hook",level:2},{value:"Custom Strategies",id:"custom-strategies",level:2}],u={toc:c};function l(t){let{components:e,...o}=t;return(0,r.kt)("wrapper",(0,n.Z)({},u,o,{components:e,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"custom-hooks"},"Custom hooks"),(0,r.kt)("p",null,"Sometimes it might be useful to wrap the framework data-fetching hooks into your own hooks."),(0,r.kt)("h2",{id:"creating-a-custom-hook-for-a-custom-post-type"},"Creating a custom hook for a custom post type"),(0,r.kt)("p",null,"Let's say you have a custom post type and you want to abstract the parameters needed to get that custom post type. You can create your own hook and pass in the required params."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/hooks/useBook.js",title:"src/hooks/useBook.js"},"import { usePost } from '@headstartwp/next';\n\nconst defaultParams = {\n postType: 'book',\n _embed: true,\n};\n\nexport function useBook(params = {}) {\n return usePost({ ...params, ...defaultParams }, options);\n}\n\nuseBook.fetcher = (sourceUrl?: string) => {\n const fetcher = usePost.fetcher(sourceUrl, defaultParams);\n return fetcher;\n};\n")),(0,r.kt)("p",null,"That way, you don't need to keep passing around the ",(0,r.kt)("inlineCode",{parentName:"p"},"defaultParams")," whenever you want to fetch a single book."),(0,r.kt)("p",null,"By wrapping ",(0,r.kt)("inlineCode",{parentName:"p"},"useBook.fetcher")," we can also pass a set of default params to the default ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," fetcher function. This ensures that when you use ",(0,r.kt)("inlineCode",{parentName:"p"},"fetchHookData")," on the server, the data is fetched using the default parameters."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"// no need to manually pass `{ params: { postType: 'book' } }\nconst bookData = await fetchHookData(useBook.fetcher(), context);\n")),(0,r.kt)("p",null,"This is also useful if you're using TypeScript and your custom post type has additional meta fields."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/hooks/useBook.ts",title:"src/hooks/useBook.ts"},"import { usePost } from '@headstartwp/next';\nimport { PostEntity, PostParams } from '@headstartwp/core';\n\nconst defaultParams: PostParams = {\n postType: 'book',\n _embed: true,\n};\n\ninterface Book extends PostEntity {\n isbn: string;\n}\n\nexport function useBook(params: PostParams | {} = {}) {\n return usePost({ ...params, ...defaultParams }, options);\n}\n\nuseBook.fetcher = (sourceUrl?: string) => {\n const fetcher = usePost.fetcher(sourceUrl, defaultParams);\n return fetcher;\n};\n")),(0,r.kt)("p",null,"Then when using the custom hook ",(0,r.kt)("inlineCode",{parentName:"p"},"isbn")," will show up as a property of the returned post objects."),(0,r.kt)("h2",{id:"creating-your-own-appsettings-hook"},"Creating your own AppSettings hook"),(0,r.kt)("p",null,"If you're using TypeScript and you are extending the framework's app endpoint and including new fields, you can create your own custom hook and specify the additional TypeScript types."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/hooks/useMyAppSettings.ts",title:"src/hooks/useMyAppSettings.ts"},"import { FetchResponse, AppEntity, AppSettingsStrategy } from '@headstartwp/core';\nimport { FetchHookOptions } from '@headstartwp/core/react';\nimport { useAppSettings } from '@headstartwp/next';\n\nexport interface MyAppSettings extends AppEntity {\n my_custom_setting: string;\n}\n\nexport function useMyAppSettings(\n options: FetchHookOptions> = {},\n) {\n return useAppSettings({}, options);\n}\n\nuseMyAppSettings.fetcher = (sourceUrl?: string) =>\n new AppSettingsStrategy(sourceUrl);\n")),(0,r.kt)("h2",{id:"custom-strategies"},"Custom Strategies"),(0,r.kt)("p",null,"Depending on what you're doing you might need to create a completely custom Fetch Strategy. A Fetch strategy must extend ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/headstartwp_core.AbstractFetchStrategy/"},"AbstractFetchStrategy")," and it must contain all of the logic needed to fetch the data."),(0,r.kt)("p",null,"If you feel like to need to create a custom strategy check out the ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/tree/develop/packages/core/src/data/strategies"},"default Fetch Strategies")," as well as the ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/tree/develop/packages/core/src/react/hooks"},"hooks")," that implements them."))}l.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1937a900.85596c29.js b/assets/js/1937a900.2da6340e.js similarity index 96% rename from assets/js/1937a900.85596c29.js rename to assets/js/1937a900.2da6340e.js index bdae9264f..4b088c50f 100644 --- a/assets/js/1937a900.85596c29.js +++ b/assets/js/1937a900.2da6340e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3138],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(r),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return r?a.createElement(h,l(l({ref:t},d),{},{components:r})):a.createElement(h,l({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,l[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.ColumnBlockProps",title:"Interface: ColumnBlockProps",sidebar_label:"@headstartwp/core.react.ColumnBlockProps",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.ColumnBlockProps",id:"interfaces/headstartwp_core.react.ColumnBlockProps",title:"Interface: ColumnBlockProps",description:"@headstartwp/core.react.ColumnBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.ColumnBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ColumnBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ColumnBlockProps",title:"Interface: ColumnBlockProps",sidebar_label:"@headstartwp/core.react.ColumnBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.Colors",permalink:"/docs/api/interfaces/headstartwp_core.react.Colors"},next:{title:"@headstartwp/core.react.ColumnsBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ColumnBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ColumnBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3138],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(r),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return r?a.createElement(h,l(l({ref:t},d),{},{components:r})):a.createElement(h,l({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,l[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.ColumnBlockProps",title:"Interface: ColumnBlockProps",sidebar_label:"@headstartwp/core.react.ColumnBlockProps",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.ColumnBlockProps",id:"interfaces/headstartwp_core.react.ColumnBlockProps",title:"Interface: ColumnBlockProps",description:"@headstartwp/core.react.ColumnBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.ColumnBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ColumnBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ColumnBlockProps",title:"Interface: ColumnBlockProps",sidebar_label:"@headstartwp/core.react.ColumnBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.Colors",permalink:"/docs/api/interfaces/headstartwp_core.react.Colors"},next:{title:"@headstartwp/core.react.ColumnsBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ColumnBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ColumnBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/19a8a98a.dde3c17f.js b/assets/js/19a8a98a.8ee8fcd9.js similarity index 96% rename from assets/js/19a8a98a.dde3c17f.js rename to assets/js/19a8a98a.8ee8fcd9.js index 7c319ce6d..2aeaa827e 100644 --- a/assets/js/19a8a98a.dde3c17f.js +++ b/assets/js/19a8a98a.8ee8fcd9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4401],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(r),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return r?a.createElement(h,l(l({ref:t},d),{},{components:r})):a.createElement(h,l({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,l[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.ListBlockProps",title:"Interface: ListBlockProps",sidebar_label:"@headstartwp/core.react.ListBlockProps",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.ListBlockProps",id:"interfaces/headstartwp_core.react.ListBlockProps",title:"Interface: ListBlockProps",description:"@headstartwp/core.react.ListBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.ListBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ListBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ListBlockProps",title:"Interface: ListBlockProps",sidebar_label:"@headstartwp/core.react.ListBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ImageBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps"},next:{title:"@headstartwp/core.react.MediaTextBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"ordered",id:"ordered",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ListBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ListBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ordered"},"ordered"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"ordered"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/ListBlock.tsx#L7"},"packages/core/src/react/blocks/ListBlock.tsx:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4401],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(r),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return r?a.createElement(h,l(l({ref:t},d),{},{components:r})):a.createElement(h,l({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,l[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.ListBlockProps",title:"Interface: ListBlockProps",sidebar_label:"@headstartwp/core.react.ListBlockProps",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.ListBlockProps",id:"interfaces/headstartwp_core.react.ListBlockProps",title:"Interface: ListBlockProps",description:"@headstartwp/core.react.ListBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.ListBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ListBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ListBlockProps",title:"Interface: ListBlockProps",sidebar_label:"@headstartwp/core.react.ListBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ImageBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps"},next:{title:"@headstartwp/core.react.MediaTextBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"ordered",id:"ordered",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ListBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ListBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ordered"},"ordered"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"ordered"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/ListBlock.tsx#L7"},"packages/core/src/react/blocks/ListBlock.tsx:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1a87c9a6.6efc31c9.js b/assets/js/1a87c9a6.0d12ca47.js similarity index 66% rename from assets/js/1a87c9a6.6efc31c9.js rename to assets/js/1a87c9a6.0d12ca47.js index 6960b3a50..602ea9460 100644 --- a/assets/js/1a87c9a6.6efc31c9.js +++ b/assets/js/1a87c9a6.0d12ca47.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2507],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>f});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function p(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var s=a.createContext({}),d=function(e){var t=a.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):p(p({},t),e)),r},c=function(e){var t=d(e.components);return a.createElement(s.Provider,{value:t},e.children)},l="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,s=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),l=d(r),u=n,f=l["".concat(s,".").concat(u)]||l[u]||h[u]||i;return r?a.createElement(f,p(p({ref:t},c),{},{components:r})):a.createElement(f,p({ref:t},c))}));function f(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,p=new Array(i);p[0]=u;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o[l]="string"==typeof e?e:n,p[1]=o;for(var d=2;d{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>l,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.SearchEntity",title:"Interface: SearchEntity",sidebar_label:"@headstartwp/core.SearchEntity",custom_edit_url:null},p=void 0,o={unversionedId:"interfaces/headstartwp_core.SearchEntity",id:"interfaces/headstartwp_core.SearchEntity",title:"Interface: SearchEntity",description:"@headstartwp/core.SearchEntity",source:"@site/docs/interfaces/headstartwp_core.SearchEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.SearchEntity",permalink:"/docs/api/interfaces/headstartwp_core.SearchEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.SearchEntity",title:"Interface: SearchEntity",sidebar_label:"@headstartwp/core.SearchEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.RevisionEntity",permalink:"/docs/api/interfaces/headstartwp_core.RevisionEntity"},next:{title:"@headstartwp/core.SearchObjectEntity",permalink:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"}},s={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"searchedValue",id:"searchedvalue",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"subtype",id:"subtype",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-4",level:4}],c={toc:d};function l(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".SearchEntity"),(0,n.kt)("p",null,"Interface for entities from the /wp/v2/search endpoint."),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,n.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"SearchEntity"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"searchedvalue"},"searchedValue"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"searchedValue"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L634"},"packages/core/src/data/types/entities.ts:634")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"subtype"},"subtype"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"subtype"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"Subtype of Search for the object."),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L644"},"packages/core/src/data/types/entities.ts:644")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"type"},"type"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"type"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Type of Search for the object."),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L639"},"packages/core/src/data/types/entities.ts:639")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}l.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2507],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>f});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var s=r.createContext({}),l=function(e){var t=r.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},d=function(e){var t=l(e.components);return r.createElement(s.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,s=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),c=l(a),u=n,f=c["".concat(s,".").concat(u)]||c[u]||h[u]||i;return a?r.createElement(f,p(p({ref:t},d),{},{components:a})):r.createElement(f,p({ref:t},d))}));function f(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=u;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o[c]="string"==typeof e?e:n,p[1]=o;for(var l=2;l{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>l});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.SearchEntity",title:"Interface: SearchEntity",sidebar_label:"@headstartwp/core.SearchEntity",custom_edit_url:null},p=void 0,o={unversionedId:"interfaces/headstartwp_core.SearchEntity",id:"interfaces/headstartwp_core.SearchEntity",title:"Interface: SearchEntity",description:"@headstartwp/core.SearchEntity",source:"@site/docs/interfaces/headstartwp_core.SearchEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.SearchEntity",permalink:"/docs/api/interfaces/headstartwp_core.SearchEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.SearchEntity",title:"Interface: SearchEntity",sidebar_label:"@headstartwp/core.SearchEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.RevisionEntity",permalink:"/docs/api/interfaces/headstartwp_core.RevisionEntity"},next:{title:"@headstartwp/core.SearchObjectEntity",permalink:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"searchedValue",id:"searchedvalue",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"subtype",id:"subtype",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-4",level:4}],d={toc:l};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".SearchEntity"),(0,n.kt)("p",null,"Interface for entities from the /wp/v2/search endpoint."),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,n.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"SearchEntity"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"searchedvalue"},"searchedValue"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"searchedValue"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L634"},"packages/core/src/data/types/entities.ts:634")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"subtype"},"subtype"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"subtype"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"Subtype of Search for the object."),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L644"},"packages/core/src/data/types/entities.ts:644")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"type"},"type"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"type"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Type of Search for the object."),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L639"},"packages/core/src/data/types/entities.ts:639")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1efe64df.4a7fbf04.js b/assets/js/1efe64df.0f95c3ce.js similarity index 96% rename from assets/js/1efe64df.4a7fbf04.js rename to assets/js/1efe64df.0f95c3ce.js index 23ee86505..58c582f69 100644 --- a/assets/js/1efe64df.4a7fbf04.js +++ b/assets/js/1efe64df.0f95c3ce.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9410],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),d=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},c=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),s=d(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||o;return a?r.createElement(h,l(l({ref:t},c),{},{components:a})):r.createElement(h,l({ref:t},c))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,l=new Array(o);l[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:n,l[1]=i;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.ICodeBlock",title:"Interface: ICodeBlock",sidebar_label:"@headstartwp/core.react.ICodeBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.ICodeBlock",id:"interfaces/headstartwp_core.react.ICodeBlock",title:"Interface: ICodeBlock",description:"@headstartwp/core.react.ICodeBlock",source:"@site/docs/interfaces/headstartwp_core.react.ICodeBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ICodeBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ICodeBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ICodeBlock",title:"Interface: ICodeBlock",sidebar_label:"@headstartwp/core.react.ICodeBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IButtonsBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IButtonsBlock"},next:{title:"@headstartwp/core.react.IColumnBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IColumnBlock"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],c={toc:d};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ICodeBlock"),(0,n.kt)("p",null,"The interface for the ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#codeblock"},"CodeBlock")," component."),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CodeBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ICodeBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CodeBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CodeBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9410],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),d=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},c=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),s=d(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||o;return a?r.createElement(h,l(l({ref:t},c),{},{components:a})):r.createElement(h,l({ref:t},c))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,l=new Array(o);l[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:n,l[1]=i;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.ICodeBlock",title:"Interface: ICodeBlock",sidebar_label:"@headstartwp/core.react.ICodeBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.ICodeBlock",id:"interfaces/headstartwp_core.react.ICodeBlock",title:"Interface: ICodeBlock",description:"@headstartwp/core.react.ICodeBlock",source:"@site/docs/interfaces/headstartwp_core.react.ICodeBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ICodeBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ICodeBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ICodeBlock",title:"Interface: ICodeBlock",sidebar_label:"@headstartwp/core.react.ICodeBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IButtonsBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IButtonsBlock"},next:{title:"@headstartwp/core.react.IColumnBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IColumnBlock"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],c={toc:d};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ICodeBlock"),(0,n.kt)("p",null,"The interface for the ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#codeblock"},"CodeBlock")," component."),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CodeBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ICodeBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CodeBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CodeBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1fbe2079.7bdb9e6a.js b/assets/js/1fbe2079.6ed425dc.js similarity index 99% rename from assets/js/1fbe2079.7bdb9e6a.js rename to assets/js/1fbe2079.6ed425dc.js index 34a9eeceb..768d9c4e8 100644 --- a/assets/js/1fbe2079.7bdb9e6a.js +++ b/assets/js/1fbe2079.6ed425dc.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2781],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>m});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=r.createContext({}),l=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},d=function(e){var t=l(e.components);return r.createElement(p.Provider,{value:t},e.children)},u="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,p=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),u=l(n),h=a,m=u["".concat(p,".").concat(h)]||u[h]||c[h]||i;return n?r.createElement(m,o(o({ref:t},d),{},{components:n})):r.createElement(m,o({ref:t},d))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=h;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s[u]="string"==typeof e?e:a,o[1]=s;for(var l=2;l{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var r=n(7462),a=(n(7294),n(3905));const i={sidebar_position:0,slug:"/wordpress-integration/previews"},o="Previews",s={unversionedId:"WordPress Integration/previews",id:"WordPress Integration/previews",title:"Previews",description:"The preview feature requires the HeadstartWP plugin installed. The preview functionality is built on top of Next.js preview API. It uses a short-lived JWT token generated on the WordPress side that can only be used for previewing, this means it is not necessary to set up a hardcoded secret between WP and Next.js.",source:"@site/documentation/06-WordPress Integration/previews.md",sourceDirName:"06-WordPress Integration",slug:"/wordpress-integration/previews",permalink:"/docs/learn/wordpress-integration/previews",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/06-WordPress Integration/previews.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",sidebarPosition:0,frontMatter:{sidebar_position:0,slug:"/wordpress-integration/previews"},sidebar:"tutorialSidebar",previous:{title:"Rendering Blocks in React Native",permalink:"/docs/learn/gutenberg/rendering-blocks-in-react-native"},next:{title:"Multisite",permalink:"/docs/learn/wordpress-integration/multisite"}},p={},l=[{value:"Usage",id:"usage",level:2},{value:"previewHandler options",id:"previewhandler-options",level:3},{value:"preparePreviewData",id:"preparepreviewdata",level:4},{value:"getRedirectPath",id:"getredirectpath",level:4},{value:"onRedirect",id:"onredirect",level:4},{value:"The usePostLinkForRedirect setting",id:"the-usepostlinkforredirect-setting",level:3},{value:"FAQ",id:"faq",level:2}],d={toc:l};function u(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"previews"},"Previews"),(0,a.kt)("p",null,"The preview feature requires the HeadstartWP plugin installed. The preview functionality is built on top of ",(0,a.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/advanced-features/preview-mode"},"Next.js preview API"),". It uses a short-lived JWT token generated on the WordPress side that can only be used for previewing, this means it is not necessary to set up a hardcoded secret between WP and Next.js."),(0,a.kt)("p",null,"For previews to work, make sure the frontend URL is entered in WP settings as per instructions in ",(0,a.kt)("a",{parentName:"p",href:"/learn/getting-started/installing-wordpress-plugin"},"Installing WordPress Plugin"),"."),(0,a.kt)("p",null,"The logic for generating the JWT token and redirecting it to the preview endpoint can be seen ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/develop/wp/headless-wp/includes/classes/Preview/preview.php"},"here"),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-php"},"$token = PreviewToken::generate(\n [\n 'type' => 'preview',\n 'post_type' => $post_type,\n 'post_id' => $post_id,\n ]\n);\n\n$preview_url = sprintf(\n '%sapi/preview?post_id=%d&post_type=%s&is_revision=%s&token=%s',\n trailingslashit( Plugin::get_react_url() ),\n $post_id,\n $post_type,\n $is_revision ? '1' : '0',\n $token\n);\n\nwp_redirect( $preview_url );\ndie();\n")),(0,a.kt)("p",null,"Below is a summary of the preview workflow."),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"First a token of type ",(0,a.kt)("inlineCode",{parentName:"li"},"preview")," is generated"),(0,a.kt)("li",{parentName:"ul"},"The token encodes the post type and post id."),(0,a.kt)("li",{parentName:"ul"},"A preview URL is generated assuming the preview endpoint lives at ",(0,a.kt)("inlineCode",{parentName:"li"},"/api/preview")),(0,a.kt)("li",{parentName:"ul"},"WordPress redirects to the preview endpoint"),(0,a.kt)("li",{parentName:"ul"},"The token is sent alongside the post_type, post_id and a boolean indicating whether the post being previewed is a revision or not. "),(0,a.kt)("li",{parentName:"ul"},"The token is verified against the parameters and the token is used to fetch the post's draft/revision content.")),(0,a.kt)("h2",{id:"usage"},"Usage"),(0,a.kt)("p",null,"The Next.js project ",(0,a.kt)("strong",{parentName:"p"},"must")," expose an ",(0,a.kt)("inlineCode",{parentName:"p"},"api/preview")," endpoint that uses the ",(0,a.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next/#previewhandler"},"previewHandler"),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"//src/pages/api/preview.js\nimport { previewHandler } from '@headstartwp/next';\n\n/**\n * The Preview endpoint just needs to proxy the default preview handler\n *\n * @param {*} req Next.js request object\n * @param {*} res Next.js response object\n *\n * @returns\n */\nexport default async function handler(req, res) {\n return previewHandler(req, res);\n}\n")),(0,a.kt)("p",null,"That's all that is needed to enable WordPress preview."),(0,a.kt)("p",null,"While previewing the URL will not reflect the actual URL of the post, but instead, it will contain the post id and a ",(0,a.kt)("inlineCode",{parentName:"p"},"-preview")," suffix."),(0,a.kt)("h3",{id:"previewhandler-options"},(0,a.kt)("inlineCode",{parentName:"h3"},"previewHandler")," options"),(0,a.kt)("h4",{id:"preparepreviewdata"},(0,a.kt)("inlineCode",{parentName:"h4"},"preparePreviewData")),(0,a.kt)("p",null,"This allows you to alter the preview data object before it is stored by Next.js (i.e before calling ",(0,a.kt)("inlineCode",{parentName:"p"},"res.setPreviewData"),"). You can use this if you need to add additional fields to preview data object."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"export default async function handler(req, res) {\n return previewHandler(req, res, {\n preparePreviewData(req, res, post, previewData) {\n return { ...previewData, name: post.name };\n },\n });\n}\n")),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"name")," would now be available in the context object of ",(0,a.kt)("inlineCode",{parentName:"p"},"getServerSideProps")," and ",(0,a.kt)("inlineCode",{parentName:"p"},"getStaticProps")," (",(0,a.kt)("inlineCode",{parentName:"p"},"ctx.previewData"),");"),(0,a.kt)("h4",{id:"getredirectpath"},(0,a.kt)("inlineCode",{parentName:"h4"},"getRedirectPath")),(0,a.kt)("admonition",{type:"info"},(0,a.kt)("p",{parentName:"admonition"},"This option was added in ",(0,a.kt)("inlineCode",{parentName:"p"},"@headstartwp/next@1.1.0"),".")),(0,a.kt)("admonition",{type:"tip"},(0,a.kt)("p",{parentName:"admonition"},"A better alternative is using ",(0,a.kt)("inlineCode",{parentName:"p"},"preview.usePostLinkForRedirect"),". With this setting, you can set up previews so that it uses the ",(0,a.kt)("inlineCode",{parentName:"p"},"post.link")," property of the post for redirecting to the appropriate path/route. This requires that your WordPress permalink matches the Next.js route structure. Check out the docs for ",(0,a.kt)("a",{parentName:"p",href:"/learn/wordpress-integration/previews#the-usepostlinkforredirect-setting"},"preview.usePostLinkForRedirect"),".")),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"getRedirectPath")," option allows you to customize the redirected URL that should handle the preview request. This can be useful if you have implemented a non-standard URL structure. For instance, if the permalink for your posts is ",(0,a.kt)("inlineCode",{parentName:"p"},"/%category%/%postname%/")," you could create a ",(0,a.kt)("inlineCode",{parentName:"p"},"/src/pages/[category]/[...path.js]")," route to handle single post. However, once you do that the ",(0,a.kt)("inlineCode",{parentName:"p"},"previewHandler")," doesn't know how to redirect to that URL and as such you will have to provide your own redirect handling."),(0,a.kt)("p",null,"The framework will also use this value to restrict the preview cookie to the post being previewed to avoid bypassing ",(0,a.kt)("inlineCode",{parentName:"p"},"getStaticProps")," until the cookie expires or the browser is closed. See the ",(0,a.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/pages/building-your-application/configuring/preview-mode#specify-the-preview-mode-duration"},"Next.js docs")," for more info."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"import { getPostTerms } from '@headstartwp/core';\nimport { previewHandler } from '@headstartwp/next';\n\nexport default async function handler(req, res) {\n return previewHandler(req, res, {\n getRedirectPath(defaultRedirectPath, post) {\n const { type, id, slug } = post;\n\n if (type === 'post') {\n const terms = getPostTerms(post);\n \n if (Array.isArray(terms?.category) && terms.category.length > 0) {\n const [category] = terms.category;\n\n return `/${categorySlug}/${id}/${slug || id}`;\n }\n }\n\n return defaultRedirectPath\n },\n });\n}\n")),(0,a.kt)("h4",{id:"onredirect"},(0,a.kt)("inlineCode",{parentName:"h4"},"onRedirect")),(0,a.kt)("admonition",{type:"tip"},(0,a.kt)("p",{parentName:"admonition"},"Instead of implementing ",(0,a.kt)("inlineCode",{parentName:"p"},"onRedirect")," we recommend implementing ",(0,a.kt)("inlineCode",{parentName:"p"},"getRedirectPath")," instead as that will only enable the preview cookie for\nthe post being previewed.")),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"onRedirect")," gives you full access to the ",(0,a.kt)("inlineCode",{parentName:"p"},"req")," and ",(0,a.kt)("inlineCode",{parentName:"p"},"res")," objects. If you do need implement this function we recommend also implementing ",(0,a.kt)("inlineCode",{parentName:"p"},"getRedirectPath"),"."),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"When handling redirects yourself, make sure to always append ",(0,a.kt)("inlineCode",{parentName:"p"},"-preview=true")," to the end of the redirected URL.")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"import { getPostTerms } from '@headstartwp/core';\nimport { previewHandler } from '@headstartwp/next';\n\nexport default async function handler(req, res) {\n return previewHandler(req, res, {\n onRedirect(req, res, previewData) {\n return res.redirect('/custom-path-preview-true');\n },\n });\n}\n")),(0,a.kt)("h3",{id:"the-usepostlinkforredirect-setting"},"The ",(0,a.kt)("inlineCode",{parentName:"h3"},"usePostLinkForRedirect")," setting"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"preview.usePostLinkForRedirect")," was added in ",(0,a.kt)("inlineCode",{parentName:"p"},"@headstartwp/next@1.3.3")," and it tells the preview handler to use the actual post permalink to figure out where it should redirect to. With this setting, previewing a post will automatically redirect to a route in Next.js based on the permalink structure set in WordPress. As an example let's say you have a custom post type called ",(0,a.kt)("inlineCode",{parentName:"p"},"news")," and its permalink structure is ",(0,a.kt)("inlineCode",{parentName:"p"},"/news/news-name"),". If your Next.js URL structure strictly follows that pattern you would have a route at ",(0,a.kt)("inlineCode",{parentName:"p"},"pages/news/[...path].js"),". Therefore HeadstartWP can infer the proper path to a preview request for a post of type ",(0,a.kt)("inlineCode",{parentName:"p"},"news"),"."),(0,a.kt)("p",null,"This becomes even more useful when you have a more complicated permalink structure, let's say your ",(0,a.kt)("inlineCode",{parentName:"p"},"news")," post type adds the category name to the url such as ",(0,a.kt)("inlineCode",{parentName:"p"},"/news/political/news-name"),". If both your Next.js project and WordPress are following the same permalink structure, no additional logic is required to get previews to work. Previously permalinks like this would require providing custom logic in ",(0,a.kt)("inlineCode",{parentName:"p"},"getRedirectPath"),"."),(0,a.kt)("p",null,"Note that by default, ",(0,a.kt)("inlineCode",{parentName:"p"},"draft")," posts will not have a pretty permalink, instead, they have something like ",(0,a.kt)("inlineCode",{parentName:"p"},"domain.com/?p=id")," so HeadstartWP adds a new rest field for all public post types called: ",(0,a.kt)("inlineCode",{parentName:"p"},"_headless_wp_preview_link")," which will return a pretty permalink even for draft posts. This field will be used by the previewHandler for draft posts."),(0,a.kt)("p",null,"If you are overriding permalink in WordPress via filter you must ensure that draft posts have a fallback post name. e.g: "),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-php"},"// adds category to the news permalink and prefix it with \"newsroom\"\nadd_filter(\n 'post_type_link',\n function ( $post_link, $post ) {\n if ( 'news' !== $post->post_type ) {\n return $post_link;\n }\n\n // draft posts won't have `$post->post_name` set.\n $post_name = empty( $post->post_name ) ? sanitize_title( $post->post_title ) : $post->post_name;\n $post_name = empty( $post_name ) ? $post->ID : $post_name;\n\n $fallback = esc_url( home_url( sprintf( 'newsroom/%s', $post_name ) ) );\n\n $news_types = wp_get_post_terms( $post->ID, 'category', [ 'fields' => 'slugs' ] );\n\n if (\n is_wp_error( $news_types ) ||\n ! is_array( $news_types ) ||\n ! count( $news_types ) > 0\n ) {\n return $fallback;\n }\n\n return esc_url( home_url( sprintf( 'newsroom/%s/%s', $news_types[0], $post_name ) ) );\n },\n 10,\n 2\n);\n")),(0,a.kt)("p",null,"You can also use a placeholder instead of manually handling post_name yourself e.g:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-php"},"$post_name = empty( $post->post_name ) ? '%postname%' : $post->post_name;\n")),(0,a.kt)("p",null,"When building the permalink for draft posts the framework will automatically replace ",(0,a.kt)("inlineCode",{parentName:"p"},"%postname")," or ",(0,a.kt)("inlineCode",{parentName:"p"},"%pagename%")," with the post_name (based on the title) or a fallback to post id."),(0,a.kt)("h2",{id:"faq"},"FAQ"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"After a while, the preview URL stops working")),(0,a.kt)("p",null,"The JWT token expires after 5 min by default, after this period, open another preview window from WordPress to preview the post. The Next.js preview cookie also last for only 5 minutes."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"I'm unable to preview a custom post type")),(0,a.kt)("p",null,"Make sure you defined the right ",(0,a.kt)("inlineCode",{parentName:"p"},"single")," property when registering the custom post type. See ",(0,a.kt)("a",{parentName:"p",href:"/learn/getting-started/headless-config/#customposttypes"},"headless config docs"),". The ",(0,a.kt)("inlineCode",{parentName:"p"},"single")," property must match the route prefix for the custom post type."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"I have a custom authentication using the Authorization header, how can I use the preview functionality?")),(0,a.kt)("p",null,"Make sure you have HeadstartWP plugin >= 1.0.1, ",(0,a.kt)("inlineCode",{parentName:"p"},"@headstartwp/core")," >= 1.3.1 and ",(0,a.kt)("inlineCode",{parentName:"p"},"@headstartwp/next"),">= 1.3.1. Then in your ",(0,a.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," add the following config:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"module.exports = {\n // other configs.\n // ...\n\n preview: {\n alternativeAuthorizationHeader: true\n }\n}\n")),(0,a.kt)("p",null,"This will tell HeadstartWP to use an alternative header (",(0,a.kt)("inlineCode",{parentName:"p"},"X-HeadstartWP-Authorization"),") instead of the default ",(0,a.kt)("inlineCode",{parentName:"p"},"Authorization")," header."))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2781],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>m});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=r.createContext({}),l=function(e){var t=r.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},d=function(e){var t=l(e.components);return r.createElement(p.Provider,{value:t},e.children)},u="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,p=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),u=l(n),h=a,m=u["".concat(p,".").concat(h)]||u[h]||c[h]||i;return n?r.createElement(m,o(o({ref:t},d),{},{components:n})):r.createElement(m,o({ref:t},d))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=h;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s[u]="string"==typeof e?e:a,o[1]=s;for(var l=2;l{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var r=n(7462),a=(n(7294),n(3905));const i={sidebar_position:0,slug:"/wordpress-integration/previews"},o="Previews",s={unversionedId:"WordPress Integration/previews",id:"WordPress Integration/previews",title:"Previews",description:"The preview feature requires the HeadstartWP plugin installed. The preview functionality is built on top of Next.js preview API. It uses a short-lived JWT token generated on the WordPress side that can only be used for previewing, this means it is not necessary to set up a hardcoded secret between WP and Next.js.",source:"@site/documentation/06-WordPress Integration/previews.md",sourceDirName:"06-WordPress Integration",slug:"/wordpress-integration/previews",permalink:"/docs/learn/wordpress-integration/previews",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/06-WordPress Integration/previews.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",sidebarPosition:0,frontMatter:{sidebar_position:0,slug:"/wordpress-integration/previews"},sidebar:"tutorialSidebar",previous:{title:"Rendering Blocks in React Native",permalink:"/docs/learn/gutenberg/rendering-blocks-in-react-native"},next:{title:"Multisite",permalink:"/docs/learn/wordpress-integration/multisite"}},p={},l=[{value:"Usage",id:"usage",level:2},{value:"previewHandler options",id:"previewhandler-options",level:3},{value:"preparePreviewData",id:"preparepreviewdata",level:4},{value:"getRedirectPath",id:"getredirectpath",level:4},{value:"onRedirect",id:"onredirect",level:4},{value:"The usePostLinkForRedirect setting",id:"the-usepostlinkforredirect-setting",level:3},{value:"FAQ",id:"faq",level:2}],d={toc:l};function u(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"previews"},"Previews"),(0,a.kt)("p",null,"The preview feature requires the HeadstartWP plugin installed. The preview functionality is built on top of ",(0,a.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/advanced-features/preview-mode"},"Next.js preview API"),". It uses a short-lived JWT token generated on the WordPress side that can only be used for previewing, this means it is not necessary to set up a hardcoded secret between WP and Next.js."),(0,a.kt)("p",null,"For previews to work, make sure the frontend URL is entered in WP settings as per instructions in ",(0,a.kt)("a",{parentName:"p",href:"/learn/getting-started/installing-wordpress-plugin"},"Installing WordPress Plugin"),"."),(0,a.kt)("p",null,"The logic for generating the JWT token and redirecting it to the preview endpoint can be seen ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/develop/wp/headless-wp/includes/classes/Preview/preview.php"},"here"),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-php"},"$token = PreviewToken::generate(\n [\n 'type' => 'preview',\n 'post_type' => $post_type,\n 'post_id' => $post_id,\n ]\n);\n\n$preview_url = sprintf(\n '%sapi/preview?post_id=%d&post_type=%s&is_revision=%s&token=%s',\n trailingslashit( Plugin::get_react_url() ),\n $post_id,\n $post_type,\n $is_revision ? '1' : '0',\n $token\n);\n\nwp_redirect( $preview_url );\ndie();\n")),(0,a.kt)("p",null,"Below is a summary of the preview workflow."),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"First a token of type ",(0,a.kt)("inlineCode",{parentName:"li"},"preview")," is generated"),(0,a.kt)("li",{parentName:"ul"},"The token encodes the post type and post id."),(0,a.kt)("li",{parentName:"ul"},"A preview URL is generated assuming the preview endpoint lives at ",(0,a.kt)("inlineCode",{parentName:"li"},"/api/preview")),(0,a.kt)("li",{parentName:"ul"},"WordPress redirects to the preview endpoint"),(0,a.kt)("li",{parentName:"ul"},"The token is sent alongside the post_type, post_id and a boolean indicating whether the post being previewed is a revision or not. "),(0,a.kt)("li",{parentName:"ul"},"The token is verified against the parameters and the token is used to fetch the post's draft/revision content.")),(0,a.kt)("h2",{id:"usage"},"Usage"),(0,a.kt)("p",null,"The Next.js project ",(0,a.kt)("strong",{parentName:"p"},"must")," expose an ",(0,a.kt)("inlineCode",{parentName:"p"},"api/preview")," endpoint that uses the ",(0,a.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next/#previewhandler"},"previewHandler"),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"//src/pages/api/preview.js\nimport { previewHandler } from '@headstartwp/next';\n\n/**\n * The Preview endpoint just needs to proxy the default preview handler\n *\n * @param {*} req Next.js request object\n * @param {*} res Next.js response object\n *\n * @returns\n */\nexport default async function handler(req, res) {\n return previewHandler(req, res);\n}\n")),(0,a.kt)("p",null,"That's all that is needed to enable WordPress preview."),(0,a.kt)("p",null,"While previewing the URL will not reflect the actual URL of the post, but instead, it will contain the post id and a ",(0,a.kt)("inlineCode",{parentName:"p"},"-preview")," suffix."),(0,a.kt)("h3",{id:"previewhandler-options"},(0,a.kt)("inlineCode",{parentName:"h3"},"previewHandler")," options"),(0,a.kt)("h4",{id:"preparepreviewdata"},(0,a.kt)("inlineCode",{parentName:"h4"},"preparePreviewData")),(0,a.kt)("p",null,"This allows you to alter the preview data object before it is stored by Next.js (i.e before calling ",(0,a.kt)("inlineCode",{parentName:"p"},"res.setPreviewData"),"). You can use this if you need to add additional fields to preview data object."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"export default async function handler(req, res) {\n return previewHandler(req, res, {\n preparePreviewData(req, res, post, previewData) {\n return { ...previewData, name: post.name };\n },\n });\n}\n")),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"name")," would now be available in the context object of ",(0,a.kt)("inlineCode",{parentName:"p"},"getServerSideProps")," and ",(0,a.kt)("inlineCode",{parentName:"p"},"getStaticProps")," (",(0,a.kt)("inlineCode",{parentName:"p"},"ctx.previewData"),");"),(0,a.kt)("h4",{id:"getredirectpath"},(0,a.kt)("inlineCode",{parentName:"h4"},"getRedirectPath")),(0,a.kt)("admonition",{type:"info"},(0,a.kt)("p",{parentName:"admonition"},"This option was added in ",(0,a.kt)("inlineCode",{parentName:"p"},"@headstartwp/next@1.1.0"),".")),(0,a.kt)("admonition",{type:"tip"},(0,a.kt)("p",{parentName:"admonition"},"A better alternative is using ",(0,a.kt)("inlineCode",{parentName:"p"},"preview.usePostLinkForRedirect"),". With this setting, you can set up previews so that it uses the ",(0,a.kt)("inlineCode",{parentName:"p"},"post.link")," property of the post for redirecting to the appropriate path/route. This requires that your WordPress permalink matches the Next.js route structure. Check out the docs for ",(0,a.kt)("a",{parentName:"p",href:"/learn/wordpress-integration/previews#the-usepostlinkforredirect-setting"},"preview.usePostLinkForRedirect"),".")),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"getRedirectPath")," option allows you to customize the redirected URL that should handle the preview request. This can be useful if you have implemented a non-standard URL structure. For instance, if the permalink for your posts is ",(0,a.kt)("inlineCode",{parentName:"p"},"/%category%/%postname%/")," you could create a ",(0,a.kt)("inlineCode",{parentName:"p"},"/src/pages/[category]/[...path.js]")," route to handle single post. However, once you do that the ",(0,a.kt)("inlineCode",{parentName:"p"},"previewHandler")," doesn't know how to redirect to that URL and as such you will have to provide your own redirect handling."),(0,a.kt)("p",null,"The framework will also use this value to restrict the preview cookie to the post being previewed to avoid bypassing ",(0,a.kt)("inlineCode",{parentName:"p"},"getStaticProps")," until the cookie expires or the browser is closed. See the ",(0,a.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/pages/building-your-application/configuring/preview-mode#specify-the-preview-mode-duration"},"Next.js docs")," for more info."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"import { getPostTerms } from '@headstartwp/core';\nimport { previewHandler } from '@headstartwp/next';\n\nexport default async function handler(req, res) {\n return previewHandler(req, res, {\n getRedirectPath(defaultRedirectPath, post) {\n const { type, id, slug } = post;\n\n if (type === 'post') {\n const terms = getPostTerms(post);\n \n if (Array.isArray(terms?.category) && terms.category.length > 0) {\n const [category] = terms.category;\n\n return `/${categorySlug}/${id}/${slug || id}`;\n }\n }\n\n return defaultRedirectPath\n },\n });\n}\n")),(0,a.kt)("h4",{id:"onredirect"},(0,a.kt)("inlineCode",{parentName:"h4"},"onRedirect")),(0,a.kt)("admonition",{type:"tip"},(0,a.kt)("p",{parentName:"admonition"},"Instead of implementing ",(0,a.kt)("inlineCode",{parentName:"p"},"onRedirect")," we recommend implementing ",(0,a.kt)("inlineCode",{parentName:"p"},"getRedirectPath")," instead as that will only enable the preview cookie for\nthe post being previewed.")),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"onRedirect")," gives you full access to the ",(0,a.kt)("inlineCode",{parentName:"p"},"req")," and ",(0,a.kt)("inlineCode",{parentName:"p"},"res")," objects. If you do need implement this function we recommend also implementing ",(0,a.kt)("inlineCode",{parentName:"p"},"getRedirectPath"),"."),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"When handling redirects yourself, make sure to always append ",(0,a.kt)("inlineCode",{parentName:"p"},"-preview=true")," to the end of the redirected URL.")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"import { getPostTerms } from '@headstartwp/core';\nimport { previewHandler } from '@headstartwp/next';\n\nexport default async function handler(req, res) {\n return previewHandler(req, res, {\n onRedirect(req, res, previewData) {\n return res.redirect('/custom-path-preview-true');\n },\n });\n}\n")),(0,a.kt)("h3",{id:"the-usepostlinkforredirect-setting"},"The ",(0,a.kt)("inlineCode",{parentName:"h3"},"usePostLinkForRedirect")," setting"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"preview.usePostLinkForRedirect")," was added in ",(0,a.kt)("inlineCode",{parentName:"p"},"@headstartwp/next@1.3.3")," and it tells the preview handler to use the actual post permalink to figure out where it should redirect to. With this setting, previewing a post will automatically redirect to a route in Next.js based on the permalink structure set in WordPress. As an example let's say you have a custom post type called ",(0,a.kt)("inlineCode",{parentName:"p"},"news")," and its permalink structure is ",(0,a.kt)("inlineCode",{parentName:"p"},"/news/news-name"),". If your Next.js URL structure strictly follows that pattern you would have a route at ",(0,a.kt)("inlineCode",{parentName:"p"},"pages/news/[...path].js"),". Therefore HeadstartWP can infer the proper path to a preview request for a post of type ",(0,a.kt)("inlineCode",{parentName:"p"},"news"),"."),(0,a.kt)("p",null,"This becomes even more useful when you have a more complicated permalink structure, let's say your ",(0,a.kt)("inlineCode",{parentName:"p"},"news")," post type adds the category name to the url such as ",(0,a.kt)("inlineCode",{parentName:"p"},"/news/political/news-name"),". If both your Next.js project and WordPress are following the same permalink structure, no additional logic is required to get previews to work. Previously permalinks like this would require providing custom logic in ",(0,a.kt)("inlineCode",{parentName:"p"},"getRedirectPath"),"."),(0,a.kt)("p",null,"Note that by default, ",(0,a.kt)("inlineCode",{parentName:"p"},"draft")," posts will not have a pretty permalink, instead, they have something like ",(0,a.kt)("inlineCode",{parentName:"p"},"domain.com/?p=id")," so HeadstartWP adds a new rest field for all public post types called: ",(0,a.kt)("inlineCode",{parentName:"p"},"_headless_wp_preview_link")," which will return a pretty permalink even for draft posts. This field will be used by the previewHandler for draft posts."),(0,a.kt)("p",null,"If you are overriding permalink in WordPress via filter you must ensure that draft posts have a fallback post name. e.g: "),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-php"},"// adds category to the news permalink and prefix it with \"newsroom\"\nadd_filter(\n 'post_type_link',\n function ( $post_link, $post ) {\n if ( 'news' !== $post->post_type ) {\n return $post_link;\n }\n\n // draft posts won't have `$post->post_name` set.\n $post_name = empty( $post->post_name ) ? sanitize_title( $post->post_title ) : $post->post_name;\n $post_name = empty( $post_name ) ? $post->ID : $post_name;\n\n $fallback = esc_url( home_url( sprintf( 'newsroom/%s', $post_name ) ) );\n\n $news_types = wp_get_post_terms( $post->ID, 'category', [ 'fields' => 'slugs' ] );\n\n if (\n is_wp_error( $news_types ) ||\n ! is_array( $news_types ) ||\n ! count( $news_types ) > 0\n ) {\n return $fallback;\n }\n\n return esc_url( home_url( sprintf( 'newsroom/%s/%s', $news_types[0], $post_name ) ) );\n },\n 10,\n 2\n);\n")),(0,a.kt)("p",null,"You can also use a placeholder instead of manually handling post_name yourself e.g:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-php"},"$post_name = empty( $post->post_name ) ? '%postname%' : $post->post_name;\n")),(0,a.kt)("p",null,"When building the permalink for draft posts the framework will automatically replace ",(0,a.kt)("inlineCode",{parentName:"p"},"%postname")," or ",(0,a.kt)("inlineCode",{parentName:"p"},"%pagename%")," with the post_name (based on the title) or a fallback to post id."),(0,a.kt)("h2",{id:"faq"},"FAQ"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"After a while, the preview URL stops working")),(0,a.kt)("p",null,"The JWT token expires after 5 min by default, after this period, open another preview window from WordPress to preview the post. The Next.js preview cookie also last for only 5 minutes."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"I'm unable to preview a custom post type")),(0,a.kt)("p",null,"Make sure you defined the right ",(0,a.kt)("inlineCode",{parentName:"p"},"single")," property when registering the custom post type. See ",(0,a.kt)("a",{parentName:"p",href:"/learn/getting-started/headless-config/#customposttypes"},"headless config docs"),". The ",(0,a.kt)("inlineCode",{parentName:"p"},"single")," property must match the route prefix for the custom post type."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"I have a custom authentication using the Authorization header, how can I use the preview functionality?")),(0,a.kt)("p",null,"Make sure you have HeadstartWP plugin >= 1.0.1, ",(0,a.kt)("inlineCode",{parentName:"p"},"@headstartwp/core")," >= 1.3.1 and ",(0,a.kt)("inlineCode",{parentName:"p"},"@headstartwp/next"),">= 1.3.1. Then in your ",(0,a.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," add the following config:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"module.exports = {\n // other configs.\n // ...\n\n preview: {\n alternativeAuthorizationHeader: true\n }\n}\n")),(0,a.kt)("p",null,"This will tell HeadstartWP to use an alternative header (",(0,a.kt)("inlineCode",{parentName:"p"},"X-HeadstartWP-Authorization"),") instead of the default ",(0,a.kt)("inlineCode",{parentName:"p"},"Authorization")," header."))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/20c672e4.ecafa8e6.js b/assets/js/20c672e4.207a6467.js similarity index 97% rename from assets/js/20c672e4.ecafa8e6.js rename to assets/js/20c672e4.207a6467.js index a0f8641d1..5b8a6392b 100644 --- a/assets/js/20c672e4.ecafa8e6.js +++ b/assets/js/20c672e4.207a6467.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2201],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>f});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function p(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var c=a.createContext({}),s=function(e){var t=a.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):p(p({},t),e)),r},l=function(e){var t=s(e.components);return a.createElement(c.Provider,{value:t},e.children)},d="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,c=e.parentName,l=i(e,["components","mdxType","originalType","parentName"]),d=s(r),u=n,f=d["".concat(c,".").concat(u)]||d[u]||h[u]||o;return r?a.createElement(f,p(p({ref:t},l),{},{components:r})):a.createElement(f,p({ref:t},l))}));function f(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,p=new Array(o);p[0]=u;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i[d]="string"==typeof e?e:n,p[1]=i;for(var s=2;s{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>p,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>s});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.FetchHookOptions",title:"Interface: FetchHookOptions",sidebar_label:"@headstartwp/core.react.FetchHookOptions",custom_edit_url:null},p=void 0,i={unversionedId:"interfaces/headstartwp_core.react.FetchHookOptions",id:"interfaces/headstartwp_core.react.FetchHookOptions",title:"Interface: FetchHookOptions",description:"@headstartwp/core.react.FetchHookOptions",source:"@site/docs/interfaces/headstartwp_core.react.FetchHookOptions.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.FetchHookOptions",permalink:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.FetchHookOptions",title:"Interface: FetchHookOptions",sidebar_label:"@headstartwp/core.react.FetchHookOptions",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.CoverBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps"},next:{title:"@headstartwp/core.react.FileBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps"}},c={},s=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"fetchStrategyOptions",id:"fetchstrategyoptions",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"shouldFetch",id:"shouldfetch",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"swr",id:"swr",level:3},{value:"Defined in",id:"defined-in-2",level:4}],l={toc:s};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".FetchHookOptions"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"fetchstrategyoptions"},"fetchStrategyOptions"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"fetchStrategyOptions"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L12"},"packages/core/src/react/hooks/types.ts:12")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"shouldfetch"},"shouldFetch"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"shouldFetch"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L14"},"packages/core/src/react/hooks/types.ts:14")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"swr"},"swr"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"swr"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"PublicConfiguration"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"BareFetcher"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">",">"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L13"},"packages/core/src/react/hooks/types.ts:13")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2201],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>f});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function p(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var c=a.createContext({}),s=function(e){var t=a.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):p(p({},t),e)),r},l=function(e){var t=s(e.components);return a.createElement(c.Provider,{value:t},e.children)},d="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,c=e.parentName,l=i(e,["components","mdxType","originalType","parentName"]),d=s(r),u=n,f=d["".concat(c,".").concat(u)]||d[u]||h[u]||o;return r?a.createElement(f,p(p({ref:t},l),{},{components:r})):a.createElement(f,p({ref:t},l))}));function f(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,p=new Array(o);p[0]=u;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i[d]="string"==typeof e?e:n,p[1]=i;for(var s=2;s{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>p,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>s});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.FetchHookOptions",title:"Interface: FetchHookOptions",sidebar_label:"@headstartwp/core.react.FetchHookOptions",custom_edit_url:null},p=void 0,i={unversionedId:"interfaces/headstartwp_core.react.FetchHookOptions",id:"interfaces/headstartwp_core.react.FetchHookOptions",title:"Interface: FetchHookOptions",description:"@headstartwp/core.react.FetchHookOptions",source:"@site/docs/interfaces/headstartwp_core.react.FetchHookOptions.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.FetchHookOptions",permalink:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.FetchHookOptions",title:"Interface: FetchHookOptions",sidebar_label:"@headstartwp/core.react.FetchHookOptions",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.CoverBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps"},next:{title:"@headstartwp/core.react.FileBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps"}},c={},s=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"fetchStrategyOptions",id:"fetchstrategyoptions",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"shouldFetch",id:"shouldfetch",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"swr",id:"swr",level:3},{value:"Defined in",id:"defined-in-2",level:4}],l={toc:s};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".FetchHookOptions"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"fetchstrategyoptions"},"fetchStrategyOptions"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"fetchStrategyOptions"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L12"},"packages/core/src/react/hooks/types.ts:12")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"shouldfetch"},"shouldFetch"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"shouldFetch"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L14"},"packages/core/src/react/hooks/types.ts:14")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"swr"},"swr"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"swr"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"PublicConfiguration"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"BareFetcher"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">",">"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L13"},"packages/core/src/react/hooks/types.ts:13")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/241565db.284336db.js b/assets/js/241565db.96315252.js similarity index 97% rename from assets/js/241565db.284336db.js rename to assets/js/241565db.96315252.js index f551dcbe1..df4c7e855 100644 --- a/assets/js/241565db.284336db.js +++ b/assets/js/241565db.96315252.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9210],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||l;return a?r.createElement(h,i(i({ref:t},d),{},{components:a})):r.createElement(h,i({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,i=new Array(l);i[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.ITableBlock",title:"Interface: ITableBlock",sidebar_label:"@headstartwp/core.react.ITableBlock",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.ITableBlock",id:"interfaces/headstartwp_core.react.ITableBlock",title:"Interface: ITableBlock",description:"@headstartwp/core.react.ITableBlock",source:"@site/docs/interfaces/headstartwp_core.react.ITableBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ITableBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ITableBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ITableBlock",title:"Interface: ITableBlock",sidebar_label:"@headstartwp/core.react.ITableBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ISpacerBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ISpacerBlock"},next:{title:"@headstartwp/core.react.IVerseBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IVerseBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ITableBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"TableBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ITableBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"TableBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"TableBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9210],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||l;return a?r.createElement(h,i(i({ref:t},d),{},{components:a})):r.createElement(h,i({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,i=new Array(l);i[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.ITableBlock",title:"Interface: ITableBlock",sidebar_label:"@headstartwp/core.react.ITableBlock",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.ITableBlock",id:"interfaces/headstartwp_core.react.ITableBlock",title:"Interface: ITableBlock",description:"@headstartwp/core.react.ITableBlock",source:"@site/docs/interfaces/headstartwp_core.react.ITableBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ITableBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ITableBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ITableBlock",title:"Interface: ITableBlock",sidebar_label:"@headstartwp/core.react.ITableBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ISpacerBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ISpacerBlock"},next:{title:"@headstartwp/core.react.IVerseBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IVerseBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ITableBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"TableBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ITableBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"TableBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"TableBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/245007dc.4e89036d.js b/assets/js/245007dc.3245437d.js similarity index 96% rename from assets/js/245007dc.4e89036d.js rename to assets/js/245007dc.3245437d.js index 1038bae13..ac27d87ff 100644 --- a/assets/js/245007dc.4e89036d.js +++ b/assets/js/245007dc.3245437d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1398],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>m});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),c=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(o.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),s=c(a),h=n,m=s["".concat(o,".").concat(h)]||s[h]||k[h]||i;return a?r.createElement(m,p(p({ref:t},d),{},{components:a})):r.createElement(m,p({ref:t},d))}));function m(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=h;var l={};for(var o in t)hasOwnProperty.call(t,o)&&(l[o]=t[o]);l.originalType=e,l[s]="string"==typeof e?e:n,p[1]=l;for(var c=2;c{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>p,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.ParagraphBlockProps",title:"Interface: ParagraphBlockProps",sidebar_label:"@headstartwp/core.react.ParagraphBlockProps",custom_edit_url:null},p=void 0,l={unversionedId:"interfaces/headstartwp_core.react.ParagraphBlockProps",id:"interfaces/headstartwp_core.react.ParagraphBlockProps",title:"Interface: ParagraphBlockProps",description:"@headstartwp/core.react.ParagraphBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.ParagraphBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ParagraphBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ParagraphBlockProps",title:"Interface: ParagraphBlockProps",sidebar_label:"@headstartwp/core.react.ParagraphBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.MediaTextBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps"},next:{title:"@headstartwp/core.react.PreformattedBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps"}},o={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"dropCap",id:"dropcap",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ParagraphBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ParagraphBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"dropcap"},"dropCap"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"dropCap"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/ParagraphBlock.tsx#L8"},"packages/core/src/react/blocks/ParagraphBlock.tsx:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1398],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>m});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),c=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(o.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),s=c(a),h=n,m=s["".concat(o,".").concat(h)]||s[h]||k[h]||i;return a?r.createElement(m,p(p({ref:t},d),{},{components:a})):r.createElement(m,p({ref:t},d))}));function m(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=h;var l={};for(var o in t)hasOwnProperty.call(t,o)&&(l[o]=t[o]);l.originalType=e,l[s]="string"==typeof e?e:n,p[1]=l;for(var c=2;c{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>p,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.ParagraphBlockProps",title:"Interface: ParagraphBlockProps",sidebar_label:"@headstartwp/core.react.ParagraphBlockProps",custom_edit_url:null},p=void 0,l={unversionedId:"interfaces/headstartwp_core.react.ParagraphBlockProps",id:"interfaces/headstartwp_core.react.ParagraphBlockProps",title:"Interface: ParagraphBlockProps",description:"@headstartwp/core.react.ParagraphBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.ParagraphBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ParagraphBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ParagraphBlockProps",title:"Interface: ParagraphBlockProps",sidebar_label:"@headstartwp/core.react.ParagraphBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.MediaTextBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps"},next:{title:"@headstartwp/core.react.PreformattedBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps"}},o={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"dropCap",id:"dropcap",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ParagraphBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ParagraphBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"dropcap"},"dropCap"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"dropCap"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/ParagraphBlock.tsx#L8"},"packages/core/src/react/blocks/ParagraphBlock.tsx:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/24728c4e.921b3139.js b/assets/js/24728c4e.10324e41.js similarity index 96% rename from assets/js/24728c4e.921b3139.js rename to assets/js/24728c4e.10324e41.js index e99b31c58..93d79a0be 100644 --- a/assets/js/24728c4e.921b3139.js +++ b/assets/js/24728c4e.10324e41.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1408],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var d=r.createContext({}),s=function(e){var t=r.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=s(e.components);return r.createElement(d.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,d=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),c=s(a),h=n,k=c["".concat(d,".").concat(h)]||c[h]||m[h]||i;return a?r.createElement(k,p(p({ref:t},o),{},{components:a})):r.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=h;var l={};for(var d in t)hasOwnProperty.call(t,d)&&(l[d]=t[d]);l.originalType=e,l[c]="string"==typeof e?e:n,p[1]=l;for(var s=2;s{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>s});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.AppSettingsStrategy",title:"Class: AppSettingsStrategy",sidebar_label:"@headstartwp/core.AppSettingsStrategy",custom_edit_url:null},p=void 0,l={unversionedId:"classes/headstartwp_core.AppSettingsStrategy",id:"classes/headstartwp_core.AppSettingsStrategy",title:"Class: AppSettingsStrategy",description:"@headstartwp/core.AppSettingsStrategy",source:"@site/docs/classes/headstartwp_core.AppSettingsStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.AppSettingsStrategy",permalink:"/docs/api/classes/headstartwp_core.AppSettingsStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.AppSettingsStrategy",title:"Class: AppSettingsStrategy",sidebar_label:"@headstartwp/core.AppSettingsStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.AbstractFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},next:{title:"@headstartwp/core.AuthorArchiveFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy"}},d={},s=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getPreviewAuthHeader",id:"getpreviewauthheader",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getPreviewHeaderName",id:"getpreviewheadername",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Defined in",id:"defined-in-21",level:4}],o={toc:s};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".AppSettingsStrategy"),(0,n.kt)("p",null,"The App Settings strategy is used to fetch the app settings endpoints exposed by the\nheadless wp plugin"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"AppSettingsStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new AppSettingsStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L143"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:143")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L119"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:119")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L124"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:124")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Builds the final endpoint URL based on the passed parameters"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to add to the request")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The endpoint URL."),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L220"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:220")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("p",null,"The default fetcher function"),(0,n.kt)("p",null,"The default fetcher function handles authentication headers and errors from the API."),(0,n.kt)("p",null,"A custom strategy can override this function to run additional logic before or after the fetch call"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL to fetch")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetcher options")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L290"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:290")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"filterOptions?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"filterOptions?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L377"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:377")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L442"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:442")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L256"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:256")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L407"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:407")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AppSettingsStrategy.ts#L15"},"packages/core/src/data/strategies/AppSettingsStrategy.ts:15")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L182"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:182")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L174"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:174")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Returns the supported params from the URL if present."),(0,n.kt)("p",null,"These params are passed to ",(0,n.kt)("inlineCode",{parentName:"p"},"buildEndpointURL"),". If the strategy does not support\nmapping url params to endpoint params, it should return an empty object."),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The Path name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"params extracted from the URL"),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AppSettingsStrategy.ts#L20"},"packages/core/src/data/strategies/AppSettingsStrategy.ts:20")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewauthheader"},"getPreviewAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getpreviewauthheader"},"getPreviewAuthHeader")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L247"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:247")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewheadername"},"getPreviewHeaderName"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewHeaderName"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getpreviewheadername"},"getPreviewHeaderName")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L241"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:241")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L365"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:365")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L205"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:205")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L417"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:417")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,n.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L233"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:233")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-14"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-16"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L164"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:164")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-15"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-17"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-19"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1408],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var d=r.createContext({}),s=function(e){var t=r.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=s(e.components);return r.createElement(d.Provider,{value:t},e.children)},m="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,d=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),m=s(a),c=n,k=m["".concat(d,".").concat(c)]||m[c]||h[c]||i;return a?r.createElement(k,p(p({ref:t},o),{},{components:a})):r.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=c;var l={};for(var d in t)hasOwnProperty.call(t,d)&&(l[d]=t[d]);l.originalType=e,l[m]="string"==typeof e?e:n,p[1]=l;for(var s=2;s{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>p,default:()=>m,frontMatter:()=>i,metadata:()=>l,toc:()=>s});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.AppSettingsStrategy",title:"Class: AppSettingsStrategy",sidebar_label:"@headstartwp/core.AppSettingsStrategy",custom_edit_url:null},p=void 0,l={unversionedId:"classes/headstartwp_core.AppSettingsStrategy",id:"classes/headstartwp_core.AppSettingsStrategy",title:"Class: AppSettingsStrategy",description:"@headstartwp/core.AppSettingsStrategy",source:"@site/docs/classes/headstartwp_core.AppSettingsStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.AppSettingsStrategy",permalink:"/docs/api/classes/headstartwp_core.AppSettingsStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.AppSettingsStrategy",title:"Class: AppSettingsStrategy",sidebar_label:"@headstartwp/core.AppSettingsStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.AbstractFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},next:{title:"@headstartwp/core.AuthorArchiveFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy"}},d={},s=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getPreviewAuthHeader",id:"getpreviewauthheader",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getPreviewHeaderName",id:"getpreviewheadername",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Defined in",id:"defined-in-21",level:4}],o={toc:s};function m(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".AppSettingsStrategy"),(0,n.kt)("p",null,"The App Settings strategy is used to fetch the app settings endpoints exposed by the\nheadless wp plugin"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"AppSettingsStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new AppSettingsStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L143"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:143")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L119"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:119")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L124"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:124")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Builds the final endpoint URL based on the passed parameters"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to add to the request")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The endpoint URL."),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L220"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:220")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("p",null,"The default fetcher function"),(0,n.kt)("p",null,"The default fetcher function handles authentication headers and errors from the API."),(0,n.kt)("p",null,"A custom strategy can override this function to run additional logic before or after the fetch call"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL to fetch")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetcher options")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L290"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:290")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"filterOptions?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"filterOptions?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L377"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:377")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L442"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:442")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L256"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:256")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L407"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:407")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AppSettingsStrategy.ts#L15"},"packages/core/src/data/strategies/AppSettingsStrategy.ts:15")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L182"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:182")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L174"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:174")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Returns the supported params from the URL if present."),(0,n.kt)("p",null,"These params are passed to ",(0,n.kt)("inlineCode",{parentName:"p"},"buildEndpointURL"),". If the strategy does not support\nmapping url params to endpoint params, it should return an empty object."),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The Path name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"params extracted from the URL"),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AppSettingsStrategy.ts#L20"},"packages/core/src/data/strategies/AppSettingsStrategy.ts:20")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewauthheader"},"getPreviewAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getpreviewauthheader"},"getPreviewAuthHeader")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L247"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:247")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewheadername"},"getPreviewHeaderName"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewHeaderName"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getpreviewheadername"},"getPreviewHeaderName")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L241"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:241")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L365"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:365")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L205"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:205")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L417"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:417")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,n.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L233"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:233")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-14"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-16"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L164"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:164")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-15"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-17"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-19"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/2772b305.621e0faf.js b/assets/js/2772b305.0d881c38.js similarity index 90% rename from assets/js/2772b305.621e0faf.js rename to assets/js/2772b305.0d881c38.js index 512ce84d5..56547d67f 100644 --- a/assets/js/2772b305.621e0faf.js +++ b/assets/js/2772b305.0d881c38.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[157],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var c=r.createContext({}),o=function(e){var t=r.useContext(c),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=o(e.components);return r.createElement(c.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,c=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),s=o(a),m=n,h=s["".concat(c,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var p={};for(var c in t)hasOwnProperty.call(t,c)&&(p[c]=t[c]);p.originalType=e,p[s]="string"==typeof e?e:n,l[1]=p;for(var o=2;o{a.r(t),a.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>p,toc:()=>o});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.ImageBlockProps",title:"Interface: ImageBlockProps",sidebar_label:"@headstartwp/core.react.ImageBlockProps",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.react.ImageBlockProps",id:"interfaces/headstartwp_core.react.ImageBlockProps",title:"Interface: ImageBlockProps",description:"@headstartwp/core.react.ImageBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.ImageBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ImageBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ImageBlockProps",title:"Interface: ImageBlockProps",sidebar_label:"@headstartwp/core.react.ImageBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IYoutubeLiteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock"},next:{title:"@headstartwp/core.react.ListBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps"}},c={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"alt",id:"alt",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"height",id:"height",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"linkDestination",id:"linkdestination",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"sizeSlug",id:"sizeslug",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"src",id:"src",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"width",id:"width",level:3},{value:"Defined in",id:"defined-in-12",level:4}],d={toc:o};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ImageBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ImageBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"alt"},"alt"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"alt"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/ImageBlock.tsx#L14"},"packages/core/src/react/blocks/ImageBlock.tsx:14")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"height"},"height"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"height"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/ImageBlock.tsx#L10"},"packages/core/src/react/blocks/ImageBlock.tsx:10")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"linkdestination"},"linkDestination"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"linkDestination"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/ImageBlock.tsx#L12"},"packages/core/src/react/blocks/ImageBlock.tsx:12")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"sizeslug"},"sizeSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"sizeSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/ImageBlock.tsx#L11"},"packages/core/src/react/blocks/ImageBlock.tsx:11")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"src"},"src"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"src"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/ImageBlock.tsx#L13"},"packages/core/src/react/blocks/ImageBlock.tsx:13")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"width"},"width"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"width"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/ImageBlock.tsx#L9"},"packages/core/src/react/blocks/ImageBlock.tsx:9")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[157],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),c=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(o.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(o,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[s]="string"==typeof e?e:n,l[1]=p;for(var c=2;c{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>p,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.ImageBlockProps",title:"Interface: ImageBlockProps",sidebar_label:"@headstartwp/core.react.ImageBlockProps",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.react.ImageBlockProps",id:"interfaces/headstartwp_core.react.ImageBlockProps",title:"Interface: ImageBlockProps",description:"@headstartwp/core.react.ImageBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.ImageBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ImageBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ImageBlockProps",title:"Interface: ImageBlockProps",sidebar_label:"@headstartwp/core.react.ImageBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IYoutubeLiteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock"},next:{title:"@headstartwp/core.react.ListBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps"}},o={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"alt",id:"alt",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"height",id:"height",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"linkDestination",id:"linkdestination",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"sizeSlug",id:"sizeslug",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"src",id:"src",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"width",id:"width",level:3},{value:"Defined in",id:"defined-in-12",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ImageBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ImageBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"alt"},"alt"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"alt"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/ImageBlock.tsx#L14"},"packages/core/src/react/blocks/ImageBlock.tsx:14")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"height"},"height"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"height"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/ImageBlock.tsx#L10"},"packages/core/src/react/blocks/ImageBlock.tsx:10")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"linkdestination"},"linkDestination"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"linkDestination"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/ImageBlock.tsx#L12"},"packages/core/src/react/blocks/ImageBlock.tsx:12")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"sizeslug"},"sizeSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"sizeSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/ImageBlock.tsx#L11"},"packages/core/src/react/blocks/ImageBlock.tsx:11")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"src"},"src"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"src"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/ImageBlock.tsx#L13"},"packages/core/src/react/blocks/ImageBlock.tsx:13")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"width"},"width"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"width"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/ImageBlock.tsx#L9"},"packages/core/src/react/blocks/ImageBlock.tsx:9")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/2cb93857.00dafb7e.js b/assets/js/2cb93857.d3adc328.js similarity index 99% rename from assets/js/2cb93857.00dafb7e.js rename to assets/js/2cb93857.d3adc328.js index c83e3d3b8..f002445d6 100644 --- a/assets/js/2cb93857.00dafb7e.js +++ b/assets/js/2cb93857.d3adc328.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5233],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>u});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var o=n.createContext({}),p=function(e){var t=n.useContext(o),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=p(e.components);return n.createElement(o.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,o=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),c=p(r),m=a,u=c["".concat(o,".").concat(m)]||c[m]||k[m]||i;return r?n.createElement(u,l(l({ref:t},s),{},{components:r})):n.createElement(u,l({ref:t},s))}));function u(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,l=new Array(i);l[0]=m;var d={};for(var o in t)hasOwnProperty.call(t,o)&&(d[o]=t[o]);d.originalType=e,d[c]="string"==typeof e?e:a,l[1]=d;for(var p=2;p{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>d,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const i={id:"headstartwp_core.EndpointError",title:"Class: EndpointError",sidebar_label:"@headstartwp/core.EndpointError",custom_edit_url:null},l=void 0,d={unversionedId:"classes/headstartwp_core.EndpointError",id:"classes/headstartwp_core.EndpointError",title:"Class: EndpointError",description:"@headstartwp/core.EndpointError",source:"@site/docs/classes/headstartwp_core.EndpointError.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.EndpointError",permalink:"/docs/api/classes/headstartwp_core.EndpointError",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.EndpointError",title:"Class: EndpointError",sidebar_label:"@headstartwp/core.EndpointError",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.Element",permalink:"/docs/api/classes/headstartwp_core.Element"},next:{title:"@headstartwp/core.FetchError",permalink:"/docs/api/classes/headstartwp_core.FetchError"}},o={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"cause",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"stack",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"prepareStackTrace",id:"preparestacktrace",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],s={toc:p};function c(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".EndpointError"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"Error")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"EndpointError"))))),(0,a.kt)("h2",{id:"constructors"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new EndpointError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"message"),")"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,"Error.constructor"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/errors.ts#L25"},"packages/core/src/utils/errors.ts:25")),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"cause"},"cause"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"cause"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"Error.cause"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"message"},"message"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"message"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"Error.message"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1054"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,"Error.name"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1053"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"stack"},"stack"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"stack"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,"Error.stack"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1055"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:127"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"preparestacktrace"},"prepareStackTrace"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"prepareStackTrace"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"err"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"stackTraces"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"CallSite"),"[]) => ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"err"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"stackTraces"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("p",null,"Optional override for formatting stack traces"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"See"))),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces"},"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces")),(0,a.kt)("h5",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"err")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Error"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"stackTraces")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"CallSite"),"[]")))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"Error.prepareStackTrace"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:140"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"stacktracelimit"},"stackTraceLimit"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"stackTraceLimit"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,"Error.stackTraceLimit"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:142"),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"capturestacktrace"},"captureStackTrace"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"captureStackTrace"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"targetObject"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"constructorOpt?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"Create .stack property on a target object"),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"targetObject")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Object"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"constructorOpt?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Function"))))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,"Error.captureStackTrace"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:133"))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5233],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>u});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var o=n.createContext({}),p=function(e){var t=n.useContext(o),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=p(e.components);return n.createElement(o.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,o=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),c=p(r),m=a,u=c["".concat(o,".").concat(m)]||c[m]||k[m]||i;return r?n.createElement(u,l(l({ref:t},s),{},{components:r})):n.createElement(u,l({ref:t},s))}));function u(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,l=new Array(i);l[0]=m;var d={};for(var o in t)hasOwnProperty.call(t,o)&&(d[o]=t[o]);d.originalType=e,d[c]="string"==typeof e?e:a,l[1]=d;for(var p=2;p{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>d,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const i={id:"headstartwp_core.EndpointError",title:"Class: EndpointError",sidebar_label:"@headstartwp/core.EndpointError",custom_edit_url:null},l=void 0,d={unversionedId:"classes/headstartwp_core.EndpointError",id:"classes/headstartwp_core.EndpointError",title:"Class: EndpointError",description:"@headstartwp/core.EndpointError",source:"@site/docs/classes/headstartwp_core.EndpointError.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.EndpointError",permalink:"/docs/api/classes/headstartwp_core.EndpointError",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.EndpointError",title:"Class: EndpointError",sidebar_label:"@headstartwp/core.EndpointError",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.Element",permalink:"/docs/api/classes/headstartwp_core.Element"},next:{title:"@headstartwp/core.FetchError",permalink:"/docs/api/classes/headstartwp_core.FetchError"}},o={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"cause",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"stack",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"prepareStackTrace",id:"preparestacktrace",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],s={toc:p};function c(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".EndpointError"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"Error")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"EndpointError"))))),(0,a.kt)("h2",{id:"constructors"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new EndpointError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"message"),")"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,"Error.constructor"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/errors.ts#L25"},"packages/core/src/utils/errors.ts:25")),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"cause"},"cause"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"cause"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"Error.cause"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"message"},"message"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"message"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"Error.message"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1054"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,"Error.name"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1053"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"stack"},"stack"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"stack"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,"Error.stack"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1055"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:127"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"preparestacktrace"},"prepareStackTrace"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"prepareStackTrace"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"err"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"stackTraces"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"CallSite"),"[]) => ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"err"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"stackTraces"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("p",null,"Optional override for formatting stack traces"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"See"))),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces"},"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces")),(0,a.kt)("h5",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"err")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Error"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"stackTraces")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"CallSite"),"[]")))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"Error.prepareStackTrace"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:140"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"stacktracelimit"},"stackTraceLimit"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"stackTraceLimit"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,"Error.stackTraceLimit"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:142"),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"capturestacktrace"},"captureStackTrace"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"captureStackTrace"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"targetObject"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"constructorOpt?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"Create .stack property on a target object"),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"targetObject")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Object"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"constructorOpt?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Function"))))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,"Error.captureStackTrace"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:133"))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/2e459592.fba61cc4.js b/assets/js/2e459592.cd2d6fe6.js similarity index 96% rename from assets/js/2e459592.fba61cc4.js rename to assets/js/2e459592.cd2d6fe6.js index d1e6fbf74..db950d96c 100644 --- a/assets/js/2e459592.fba61cc4.js +++ b/assets/js/2e459592.cd2d6fe6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3864],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),s=c(r),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return r?a.createElement(h,o(o({ref:t},d),{},{components:r})):a.createElement(h,o({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[s]="string"==typeof e?e:n,o[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.CodeBlockProps",title:"Interface: CodeBlockProps",sidebar_label:"@headstartwp/core.react.CodeBlockProps",custom_edit_url:null},o=void 0,l={unversionedId:"interfaces/headstartwp_core.react.CodeBlockProps",id:"interfaces/headstartwp_core.react.CodeBlockProps",title:"Interface: CodeBlockProps",description:"@headstartwp/core.react.CodeBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.CodeBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.CodeBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.CodeBlockProps",title:"Interface: CodeBlockProps",sidebar_label:"@headstartwp/core.react.CodeBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ButtonsBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps"},next:{title:"@headstartwp/core.react.Colors",permalink:"/docs/api/interfaces/headstartwp_core.react.Colors"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".CodeBlockProps"),(0,n.kt)("p",null,"The interface for components rendered by ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#codeblock"},"CodeBlock")),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"CodeBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3864],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),s=c(r),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return r?a.createElement(h,o(o({ref:t},d),{},{components:r})):a.createElement(h,o({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[s]="string"==typeof e?e:n,o[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.CodeBlockProps",title:"Interface: CodeBlockProps",sidebar_label:"@headstartwp/core.react.CodeBlockProps",custom_edit_url:null},o=void 0,l={unversionedId:"interfaces/headstartwp_core.react.CodeBlockProps",id:"interfaces/headstartwp_core.react.CodeBlockProps",title:"Interface: CodeBlockProps",description:"@headstartwp/core.react.CodeBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.CodeBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.CodeBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.CodeBlockProps",title:"Interface: CodeBlockProps",sidebar_label:"@headstartwp/core.react.CodeBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ButtonsBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps"},next:{title:"@headstartwp/core.react.Colors",permalink:"/docs/api/interfaces/headstartwp_core.react.Colors"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".CodeBlockProps"),(0,n.kt)("p",null,"The interface for components rendered by ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#codeblock"},"CodeBlock")),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"CodeBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/2f6d1272.086368aa.js b/assets/js/2f6d1272.0a925ef7.js similarity index 98% rename from assets/js/2f6d1272.086368aa.js rename to assets/js/2f6d1272.0a925ef7.js index 2105955a4..3f0569868 100644 --- a/assets/js/2f6d1272.086368aa.js +++ b/assets/js/2f6d1272.0a925ef7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5835],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>g});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var c=n.createContext({}),p=function(e){var t=n.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},s=function(e){var t=p(e.components);return n.createElement(c.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,c=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),d=p(r),f=a,g=d["".concat(c,".").concat(f)]||d[f]||u[f]||o;return r?n.createElement(g,i(i({ref:t},s),{},{components:r})):n.createElement(g,i({ref:t},s))}));function g(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=f;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l[d]="string"==typeof e?e:a,i[1]=l;for(var p=2;p{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>l,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const o={id:"headstartwp_core.PolylangIntegration",title:"Interface: PolylangIntegration",sidebar_label:"@headstartwp/core.PolylangIntegration",custom_edit_url:null},i=void 0,l={unversionedId:"interfaces/headstartwp_core.PolylangIntegration",id:"interfaces/headstartwp_core.PolylangIntegration",title:"Interface: PolylangIntegration",description:"@headstartwp/core.PolylangIntegration",source:"@site/docs/interfaces/headstartwp_core.PolylangIntegration.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PolylangIntegration",permalink:"/docs/api/interfaces/headstartwp_core.PolylangIntegration",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PolylangIntegration",title:"Interface: PolylangIntegration",sidebar_label:"@headstartwp/core.PolylangIntegration",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PageInfo",permalink:"/docs/api/interfaces/headstartwp_core.PageInfo"},next:{title:"@headstartwp/core.PostEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostEntity"}},c={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"enable",id:"enable",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4}],s={toc:p};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PolylangIntegration"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Integration"},(0,a.kt)("inlineCode",{parentName:"a"},"Integration"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"PolylangIntegration"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"enable"},"enable"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"enable"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Integration"},"Integration"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Integration#enable"},"enable")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/types.ts#L46"},"packages/core/src/types.ts:46")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5835],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>g});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var c=n.createContext({}),p=function(e){var t=n.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},s=function(e){var t=p(e.components);return n.createElement(c.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,c=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),d=p(r),f=a,g=d["".concat(c,".").concat(f)]||d[f]||u[f]||o;return r?n.createElement(g,i(i({ref:t},s),{},{components:r})):n.createElement(g,i({ref:t},s))}));function g(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=f;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l[d]="string"==typeof e?e:a,i[1]=l;for(var p=2;p{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>l,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const o={id:"headstartwp_core.PolylangIntegration",title:"Interface: PolylangIntegration",sidebar_label:"@headstartwp/core.PolylangIntegration",custom_edit_url:null},i=void 0,l={unversionedId:"interfaces/headstartwp_core.PolylangIntegration",id:"interfaces/headstartwp_core.PolylangIntegration",title:"Interface: PolylangIntegration",description:"@headstartwp/core.PolylangIntegration",source:"@site/docs/interfaces/headstartwp_core.PolylangIntegration.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PolylangIntegration",permalink:"/docs/api/interfaces/headstartwp_core.PolylangIntegration",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PolylangIntegration",title:"Interface: PolylangIntegration",sidebar_label:"@headstartwp/core.PolylangIntegration",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PageInfo",permalink:"/docs/api/interfaces/headstartwp_core.PageInfo"},next:{title:"@headstartwp/core.PostEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostEntity"}},c={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"enable",id:"enable",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4}],s={toc:p};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PolylangIntegration"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Integration"},(0,a.kt)("inlineCode",{parentName:"a"},"Integration"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"PolylangIntegration"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"enable"},"enable"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"enable"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Integration"},"Integration"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Integration#enable"},"enable")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/types.ts#L46"},"packages/core/src/types.ts:46")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/2f847acf.1bc69d29.js b/assets/js/2f847acf.77721f13.js similarity index 96% rename from assets/js/2f847acf.1bc69d29.js rename to assets/js/2f847acf.77721f13.js index ed1ce04c4..91cb3336b 100644 --- a/assets/js/2f847acf.1bc69d29.js +++ b/assets/js/2f847acf.77721f13.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3333],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function o(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),c=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},d=function(e){var t=c(e.components);return n.createElement(p.Provider,{value:t},e.children)},s="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),k=r,h=s["".concat(p,".").concat(k)]||s[k]||m[k]||l;return a?n.createElement(h,o(o({ref:t},d),{},{components:a})):n.createElement(h,o({ref:t},d))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,o=new Array(l);o[0]=k;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:r,o[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>l,metadata:()=>i,toc:()=>c});var n=a(7462),r=(a(7294),a(3905));const l={id:"headstartwp_core.react.IColumnBlock",title:"Interface: IColumnBlock",sidebar_label:"@headstartwp/core.react.IColumnBlock",custom_edit_url:null},o=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IColumnBlock",id:"interfaces/headstartwp_core.react.IColumnBlock",title:"Interface: IColumnBlock",description:"@headstartwp/core.react.IColumnBlock",source:"@site/docs/interfaces/headstartwp_core.react.IColumnBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IColumnBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IColumnBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IColumnBlock",title:"Interface: IColumnBlock",sidebar_label:"@headstartwp/core.react.IColumnBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ICodeBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ICodeBlock"},next:{title:"@headstartwp/core.react.IColumnsBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IColumnsBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IColumnBlock"),(0,r.kt)("p",null,"The common interface for a block transform component"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ColumnBlockProps")),">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"IColumnBlock"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"children"},"children"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"children"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,r.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,r.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classlist"},"classList"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"classList"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classname"},"className"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"className"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"component"},"component"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"component"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ColumnBlockProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ColumnBlockProps")))))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domnode"},"domNode"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"domNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,r.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,r.kt)("h5",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"childNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h5",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"style"},"style"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"style"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The style tag of the domNode as an object."),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tagname"},"tagName"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tagName"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3333],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function o(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),c=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},d=function(e){var t=c(e.components);return n.createElement(p.Provider,{value:t},e.children)},s="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),k=r,h=s["".concat(p,".").concat(k)]||s[k]||m[k]||l;return a?n.createElement(h,o(o({ref:t},d),{},{components:a})):n.createElement(h,o({ref:t},d))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,o=new Array(l);o[0]=k;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:r,o[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>l,metadata:()=>i,toc:()=>c});var n=a(7462),r=(a(7294),a(3905));const l={id:"headstartwp_core.react.IColumnBlock",title:"Interface: IColumnBlock",sidebar_label:"@headstartwp/core.react.IColumnBlock",custom_edit_url:null},o=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IColumnBlock",id:"interfaces/headstartwp_core.react.IColumnBlock",title:"Interface: IColumnBlock",description:"@headstartwp/core.react.IColumnBlock",source:"@site/docs/interfaces/headstartwp_core.react.IColumnBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IColumnBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IColumnBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IColumnBlock",title:"Interface: IColumnBlock",sidebar_label:"@headstartwp/core.react.IColumnBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ICodeBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ICodeBlock"},next:{title:"@headstartwp/core.react.IColumnsBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IColumnsBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IColumnBlock"),(0,r.kt)("p",null,"The common interface for a block transform component"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ColumnBlockProps")),">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"IColumnBlock"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"children"},"children"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"children"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,r.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,r.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classlist"},"classList"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"classList"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classname"},"className"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"className"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"component"},"component"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"component"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ColumnBlockProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ColumnBlockProps")))))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domnode"},"domNode"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"domNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,r.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,r.kt)("h5",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"childNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h5",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"style"},"style"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"style"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The style tag of the domNode as an object."),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tagname"},"tagName"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tagName"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/312a1558.3042011e.js b/assets/js/312a1558.96f731ce.js similarity index 95% rename from assets/js/312a1558.3042011e.js rename to assets/js/312a1558.96f731ce.js index f2e12ea85..8a3d51a73 100644 --- a/assets/js/312a1558.3042011e.js +++ b/assets/js/312a1558.96f731ce.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2376],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function o(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,o(o({ref:t},d),{},{components:a})):r.createElement(h,o({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,o=new Array(i);o[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[s]="string"==typeof e?e:n,o[1]=l;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.IYoutubeLiteBlock",title:"Interface: IYoutubeLiteBlock",sidebar_label:"@headstartwp/core.react.IYoutubeLiteBlock",custom_edit_url:null},o=void 0,l={unversionedId:"interfaces/headstartwp_core.react.IYoutubeLiteBlock",id:"interfaces/headstartwp_core.react.IYoutubeLiteBlock",title:"Interface: IYoutubeLiteBlock",description:"@headstartwp/core.react.IYoutubeLiteBlock",source:"@site/docs/interfaces/headstartwp_core.react.IYoutubeLiteBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IYoutubeLiteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IYoutubeLiteBlock",title:"Interface: IYoutubeLiteBlock",sidebar_label:"@headstartwp/core.react.IYoutubeLiteBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IVerseBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IVerseBlock"},next:{title:"@headstartwp/core.react.ImageBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IYoutubeLiteBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"YoutubeLiteBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IYoutubeLiteBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"YoutubeLiteBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"YoutubeLiteBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2376],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function o(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,o(o({ref:t},d),{},{components:a})):r.createElement(h,o({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,o=new Array(i);o[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[s]="string"==typeof e?e:n,o[1]=l;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.IYoutubeLiteBlock",title:"Interface: IYoutubeLiteBlock",sidebar_label:"@headstartwp/core.react.IYoutubeLiteBlock",custom_edit_url:null},o=void 0,l={unversionedId:"interfaces/headstartwp_core.react.IYoutubeLiteBlock",id:"interfaces/headstartwp_core.react.IYoutubeLiteBlock",title:"Interface: IYoutubeLiteBlock",description:"@headstartwp/core.react.IYoutubeLiteBlock",source:"@site/docs/interfaces/headstartwp_core.react.IYoutubeLiteBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IYoutubeLiteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IYoutubeLiteBlock",title:"Interface: IYoutubeLiteBlock",sidebar_label:"@headstartwp/core.react.IYoutubeLiteBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IVerseBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IVerseBlock"},next:{title:"@headstartwp/core.react.ImageBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IYoutubeLiteBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"YoutubeLiteBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IYoutubeLiteBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"YoutubeLiteBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"YoutubeLiteBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/31d83884.8266e377.js b/assets/js/31d83884.8266e377.js deleted file mode 100644 index 5ae4a7c0a..000000000 --- a/assets/js/31d83884.8266e377.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2960],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function s(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var i=a.createContext({}),d=function(e){var t=a.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},c=function(e){var t=d(e.components);return a.createElement(i.Provider,{value:t},e.children)},l="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,i=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),l=d(r),k=n,h=l["".concat(i,".").concat(k)]||l[k]||u[k]||o;return r?a.createElement(h,s(s({ref:t},c),{},{components:r})):a.createElement(h,s({ref:t},c))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,s=new Array(o);s[0]=k;var p={};for(var i in t)hasOwnProperty.call(t,i)&&(p[i]=t[i]);p.originalType=e,p[l]="string"==typeof e?e:n,s[1]=p;for(var d=2;d{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>p,toc:()=>d});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.usePostResponse",title:"Interface: usePostResponse",sidebar_label:"@headstartwp/core.react.usePostResponse",custom_edit_url:null},s=void 0,p={unversionedId:"interfaces/headstartwp_core.react.usePostResponse",id:"interfaces/headstartwp_core.react.usePostResponse",title:"Interface: usePostResponse",description:"@headstartwp/core.react.usePostResponse",source:"@site/docs/interfaces/headstartwp_core.react.usePostResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.usePostResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.usePostResponse",title:"Interface: usePostResponse",sidebar_label:"@headstartwp/core.react.usePostResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.usePostOrPostResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse"},next:{title:"@headstartwp/core.react.usePostsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"}},i={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],c={toc:d};function l(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".usePostResponse"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"usePostResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"post")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/useFetchPost.ts#L15"},"packages/core/src/react/hooks/useFetchPost.ts:15")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")))}l.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/31d83884.88c9c1ec.js b/assets/js/31d83884.88c9c1ec.js new file mode 100644 index 000000000..98b81efa5 --- /dev/null +++ b/assets/js/31d83884.88c9c1ec.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2960],{3905:(e,t,a)=>{a.d(t,{Zo:()=>l,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function s(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var i=r.createContext({}),d=function(e){var t=r.useContext(i),a=t;return e&&(a="function"==typeof e?e(t):s(s({},t),e)),a},l=function(e){var t=d(e.components);return r.createElement(i.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,i=e.parentName,l=p(e,["components","mdxType","originalType","parentName"]),c=d(a),u=n,h=c["".concat(i,".").concat(u)]||c[u]||k[u]||o;return a?r.createElement(h,s(s({ref:t},l),{},{components:a})):r.createElement(h,s({ref:t},l))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,s=new Array(o);s[0]=u;var p={};for(var i in t)hasOwnProperty.call(t,i)&&(p[i]=t[i]);p.originalType=e,p[c]="string"==typeof e?e:n,s[1]=p;for(var d=2;d{a.r(t),a.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>c,frontMatter:()=>o,metadata:()=>p,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.usePostResponse",title:"Interface: usePostResponse",sidebar_label:"@headstartwp/core.react.usePostResponse",custom_edit_url:null},s=void 0,p={unversionedId:"interfaces/headstartwp_core.react.usePostResponse",id:"interfaces/headstartwp_core.react.usePostResponse",title:"Interface: usePostResponse",description:"@headstartwp/core.react.usePostResponse",source:"@site/docs/interfaces/headstartwp_core.react.usePostResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.usePostResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.usePostResponse",title:"Interface: usePostResponse",sidebar_label:"@headstartwp/core.react.usePostResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.usePostOrPostResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse"},next:{title:"@headstartwp/core.react.usePostsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"}},i={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"mutate",id:"mutate",level:3},{value:"Defined in",id:"defined-in-4",level:4}],l={toc:d};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},l,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".usePostResponse"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"usePostResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"pageInfo")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"post")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"queriedObject")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject")))))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetchPost.ts#L16"},"packages/core/src/react/hooks/useFetchPost.ts:16")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"mutate"},"mutate"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"mutate"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"KeyedMutator"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetchPost.ts#L21"},"packages/core/src/react/hooks/useFetchPost.ts:21")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/35c3fc85.8d026205.js b/assets/js/35c3fc85.1acfa2c9.js similarity index 86% rename from assets/js/35c3fc85.8d026205.js rename to assets/js/35c3fc85.1acfa2c9.js index 9e71ee634..d0b943dbf 100644 --- a/assets/js/35c3fc85.8d026205.js +++ b/assets/js/35c3fc85.1acfa2c9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9673],{3905:(e,t,n)=>{n.d(t,{Zo:()=>o,kt:()=>h});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function p(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var l=a.createContext({}),s=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},o=function(e){var t=s(e.components);return a.createElement(l.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,l=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),c=s(n),k=r,h=c["".concat(l,".").concat(k)]||c[k]||u[k]||i;return n?a.createElement(h,p(p({ref:t},o),{},{components:n})):a.createElement(h,p({ref:t},o))}));function h(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,p=new Array(i);p[0]=k;var d={};for(var l in t)hasOwnProperty.call(t,l)&&(d[l]=t[l]);d.originalType=e,d[c]="string"==typeof e?e:r,p[1]=d;for(var s=2;s{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>d,toc:()=>s});var a=n(7462),r=(n(7294),n(3905));const i={id:"headstartwp_core.TermEntity",title:"Interface: TermEntity",sidebar_label:"@headstartwp/core.TermEntity",custom_edit_url:null},p=void 0,d={unversionedId:"interfaces/headstartwp_core.TermEntity",id:"interfaces/headstartwp_core.TermEntity",title:"Interface: TermEntity",description:"@headstartwp/core.TermEntity",source:"@site/docs/interfaces/headstartwp_core.TermEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.TermEntity",permalink:"/docs/api/interfaces/headstartwp_core.TermEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.TermEntity",title:"Interface: TermEntity",sidebar_label:"@headstartwp/core.TermEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.TaxonomyEntity",permalink:"/docs/api/interfaces/headstartwp_core.TaxonomyEntity"},next:{title:"@headstartwp/core.TermSearchEntity",permalink:"/docs/api/interfaces/headstartwp_core.TermSearchEntity"}},l={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"count",id:"count",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"link",id:"link",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"meta",id:"meta",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"parent",id:"parent",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"taxonomy",id:"taxonomy",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-10",level:4}],o={toc:s};function c(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".TermEntity"),(0,r.kt)("p",null,"Interface for entities that belong to a taxonomy."),(0,r.kt)("p",null,"For example:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"entities from the /wp/v2/categories endpoint."),(0,r.kt)("li",{parentName:"ul"},"entities from the /wp/v2/tags endpoint.")),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,r.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"TermEntity"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"count"},"count"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"count"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Number of published posts for the term."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L441"},"packages/core/src/data/types/entities.ts:441")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"HTML description of the term."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L446"},"packages/core/src/data/types/entities.ts:446")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"id"},"id"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Unique identifier for the term."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L436"},"packages/core/src/data/types/entities.ts:436")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"link"},"link"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"link"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"URL of the term."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L451"},"packages/core/src/data/types/entities.ts:451")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"meta"},"meta"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,r.kt)("p",null,"Meta fields."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L476"},"packages/core/src/data/types/entities.ts:476")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"HTML title for the term."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L456"},"packages/core/src/data/types/entities.ts:456")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"parent"},"parent"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"parent"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The parent term ID."),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L471"},"packages/core/src/data/types/entities.ts:471")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"slug"},"slug"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"An alphanumeric identifier for the term unique to its type."),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L461"},"packages/core/src/data/types/entities.ts:461")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"taxonomy"},"taxonomy"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"taxonomy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Type attribution for the term."),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L466"},"packages/core/src/data/types/entities.ts:466")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L479"},"packages/core/src/data/types/entities.ts:479")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L478"},"packages/core/src/data/types/entities.ts:478")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9673],{3905:(e,t,n)=>{n.d(t,{Zo:()=>o,kt:()=>h});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function p(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var s=a.createContext({}),d=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},o=function(e){var t=d(e.components);return a.createElement(s.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),c=d(n),k=r,h=c["".concat(s,".").concat(k)]||c[k]||u[k]||i;return n?a.createElement(h,p(p({ref:t},o),{},{components:n})):a.createElement(h,p({ref:t},o))}));function h(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,p=new Array(i);p[0]=k;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[c]="string"==typeof e?e:r,p[1]=l;for(var d=2;d{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var a=n(7462),r=(n(7294),n(3905));const i={id:"headstartwp_core.TermEntity",title:"Interface: TermEntity",sidebar_label:"@headstartwp/core.TermEntity",custom_edit_url:null},p=void 0,l={unversionedId:"interfaces/headstartwp_core.TermEntity",id:"interfaces/headstartwp_core.TermEntity",title:"Interface: TermEntity",description:"@headstartwp/core.TermEntity",source:"@site/docs/interfaces/headstartwp_core.TermEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.TermEntity",permalink:"/docs/api/interfaces/headstartwp_core.TermEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.TermEntity",title:"Interface: TermEntity",sidebar_label:"@headstartwp/core.TermEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.TaxonomyEntity",permalink:"/docs/api/interfaces/headstartwp_core.TaxonomyEntity"},next:{title:"@headstartwp/core.TermSearchEntity",permalink:"/docs/api/interfaces/headstartwp_core.TermSearchEntity"}},s={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"count",id:"count",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"link",id:"link",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"meta",id:"meta",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"parent",id:"parent",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"taxonomy",id:"taxonomy",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-10",level:4}],o={toc:d};function c(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".TermEntity"),(0,r.kt)("p",null,"Interface for entities that belong to a taxonomy."),(0,r.kt)("p",null,"For example:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"entities from the /wp/v2/categories endpoint."),(0,r.kt)("li",{parentName:"ul"},"entities from the /wp/v2/tags endpoint.")),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,r.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"TermEntity"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"count"},"count"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"count"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Number of published posts for the term."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L441"},"packages/core/src/data/types/entities.ts:441")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"HTML description of the term."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L446"},"packages/core/src/data/types/entities.ts:446")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"id"},"id"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Unique identifier for the term."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L436"},"packages/core/src/data/types/entities.ts:436")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"link"},"link"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"link"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"URL of the term."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L451"},"packages/core/src/data/types/entities.ts:451")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"meta"},"meta"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,r.kt)("p",null,"Meta fields."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L476"},"packages/core/src/data/types/entities.ts:476")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"HTML title for the term."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L456"},"packages/core/src/data/types/entities.ts:456")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"parent"},"parent"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"parent"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The parent term ID."),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L471"},"packages/core/src/data/types/entities.ts:471")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"slug"},"slug"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"An alphanumeric identifier for the term unique to its type."),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L461"},"packages/core/src/data/types/entities.ts:461")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"taxonomy"},"taxonomy"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"taxonomy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Type attribution for the term."),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L466"},"packages/core/src/data/types/entities.ts:466")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L479"},"packages/core/src/data/types/entities.ts:479")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L478"},"packages/core/src/data/types/entities.ts:478")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/37b079cc.037105ff.js b/assets/js/37b079cc.b4887f3c.js similarity index 96% rename from assets/js/37b079cc.037105ff.js rename to assets/js/37b079cc.b4887f3c.js index 3aca45abe..1d5ac1b41 100644 --- a/assets/js/37b079cc.037105ff.js +++ b/assets/js/37b079cc.b4887f3c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7307],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function o(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),d=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},c=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),s=d(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,o(o({ref:t},c),{},{components:a})):r.createElement(h,o({ref:t},c))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,o=new Array(i);o[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[s]="string"==typeof e?e:n,o[1]=l;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.IAudioBlock",title:"Interface: IAudioBlock",sidebar_label:"@headstartwp/core.react.IAudioBlock",custom_edit_url:null},o=void 0,l={unversionedId:"interfaces/headstartwp_core.react.IAudioBlock",id:"interfaces/headstartwp_core.react.IAudioBlock",title:"Interface: IAudioBlock",description:"@headstartwp/core.react.IAudioBlock",source:"@site/docs/interfaces/headstartwp_core.react.IAudioBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IAudioBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IAudioBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IAudioBlock",title:"Interface: IAudioBlock",sidebar_label:"@headstartwp/core.react.IAudioBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.HtmlDecodeProps",permalink:"/docs/api/interfaces/headstartwp_core.react.HtmlDecodeProps"},next:{title:"@headstartwp/core.react.IBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IBlock"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],c={toc:d};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IAudioBlock"),(0,n.kt)("p",null,"The interface for the ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#audioblock"},"AudioBlock")," component."),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"AudioBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IAudioBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"AudioBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"AudioBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7307],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function o(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),d=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},c=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),s=d(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,o(o({ref:t},c),{},{components:a})):r.createElement(h,o({ref:t},c))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,o=new Array(i);o[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[s]="string"==typeof e?e:n,o[1]=l;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.IAudioBlock",title:"Interface: IAudioBlock",sidebar_label:"@headstartwp/core.react.IAudioBlock",custom_edit_url:null},o=void 0,l={unversionedId:"interfaces/headstartwp_core.react.IAudioBlock",id:"interfaces/headstartwp_core.react.IAudioBlock",title:"Interface: IAudioBlock",description:"@headstartwp/core.react.IAudioBlock",source:"@site/docs/interfaces/headstartwp_core.react.IAudioBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IAudioBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IAudioBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IAudioBlock",title:"Interface: IAudioBlock",sidebar_label:"@headstartwp/core.react.IAudioBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.HtmlDecodeProps",permalink:"/docs/api/interfaces/headstartwp_core.react.HtmlDecodeProps"},next:{title:"@headstartwp/core.react.IBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IBlock"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],c={toc:d};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IAudioBlock"),(0,n.kt)("p",null,"The interface for the ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#audioblock"},"AudioBlock")," component."),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"AudioBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IAudioBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"AudioBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"AudioBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/37bc9424.24ace808.js b/assets/js/37bc9424.24ace808.js new file mode 100644 index 000000000..cf24d53b1 --- /dev/null +++ b/assets/js/37bc9424.24ace808.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[631],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>u});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function o(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var s=r.createContext({}),c=function(e){var t=r.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(s.Provider,{value:t},e.children)},l="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,s=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),l=c(a),k=n,u=l["".concat(s,".").concat(k)]||l[k]||h[k]||i;return a?r.createElement(u,o(o({ref:t},d),{},{components:a})):r.createElement(u,o({ref:t},d))}));function u(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,o=new Array(i);o[0]=k;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[l]="string"==typeof e?e:n,o[1]=p;for(var c=2;c{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>l,frontMatter:()=>i,metadata:()=>p,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.useSearchNativeResponse",title:"Interface: useSearchNativeResponse",sidebar_label:"@headstartwp/core.react.useSearchNativeResponse",custom_edit_url:null},o=void 0,p={unversionedId:"interfaces/headstartwp_core.react.useSearchNativeResponse",id:"interfaces/headstartwp_core.react.useSearchNativeResponse",title:"Interface: useSearchNativeResponse",description:"@headstartwp/core.react.useSearchNativeResponse",source:"@site/docs/interfaces/headstartwp_core.react.useSearchNativeResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.useSearchNativeResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useSearchNativeResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.useSearchNativeResponse",title:"Interface: useSearchNativeResponse",sidebar_label:"@headstartwp/core.react.useSearchNativeResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.usePostsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"},next:{title:"@headstartwp/core.react.useSearchResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse"}},s={},c=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"mutate",id:"mutate",level:3},{value:"Defined in",id:"defined-in-4",level:4}],d={toc:c};function l(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".useSearchNativeResponse"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostSearchEntity"))," ","|"," ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermSearchEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermSearchEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostSearchEntity"))," ","|"," ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermSearchEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermSearchEntity")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"useSearchNativeResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"pageInfo")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"queriedObject")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"searchResults")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]")))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetchSearchNative.ts#L22"},"packages/core/src/react/hooks/useFetchSearchNative.ts:22")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"mutate"},"mutate"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"mutate"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"KeyedMutator"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetchSearchNative.ts#L23"},"packages/core/src/react/hooks/useFetchSearchNative.ts:23")))}l.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/37bc9424.f8490f66.js b/assets/js/37bc9424.f8490f66.js deleted file mode 100644 index 07cb67905..000000000 --- a/assets/js/37bc9424.f8490f66.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[631],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>u});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function o(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var s=r.createContext({}),c=function(e){var t=r.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(s.Provider,{value:t},e.children)},l="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,s=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),l=c(a),k=n,u=l["".concat(s,".").concat(k)]||l[k]||h[k]||i;return a?r.createElement(u,o(o({ref:t},d),{},{components:a})):r.createElement(u,o({ref:t},d))}));function u(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,o=new Array(i);o[0]=k;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[l]="string"==typeof e?e:n,o[1]=p;for(var c=2;c{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>l,frontMatter:()=>i,metadata:()=>p,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.useSearchNativeResponse",title:"Interface: useSearchNativeResponse",sidebar_label:"@headstartwp/core.react.useSearchNativeResponse",custom_edit_url:null},o=void 0,p={unversionedId:"interfaces/headstartwp_core.react.useSearchNativeResponse",id:"interfaces/headstartwp_core.react.useSearchNativeResponse",title:"Interface: useSearchNativeResponse",description:"@headstartwp/core.react.useSearchNativeResponse",source:"@site/docs/interfaces/headstartwp_core.react.useSearchNativeResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.useSearchNativeResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useSearchNativeResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.useSearchNativeResponse",title:"Interface: useSearchNativeResponse",sidebar_label:"@headstartwp/core.react.useSearchNativeResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.usePostsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"},next:{title:"@headstartwp/core.react.useSearchResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse"}},s={},c=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],d={toc:c};function l(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".useSearchNativeResponse"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostSearchEntity"))," ","|"," ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermSearchEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermSearchEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostSearchEntity"))," ","|"," ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermSearchEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermSearchEntity")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"useSearchNativeResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"pageInfo")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"queriedObject")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"searchResults")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]")))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/useFetchSearchNative.ts#L21"},"packages/core/src/react/hooks/useFetchSearchNative.ts:21")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")))}l.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/37d12b40.10d1edd6.js b/assets/js/37d12b40.10d1edd6.js deleted file mode 100644 index fe4677d78..000000000 --- a/assets/js/37d12b40.10d1edd6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[26],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>u});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function s(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var i=a.createContext({}),d=function(e){var t=a.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},l=function(e){var t=d(e.components);return a.createElement(i.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,i=e.parentName,l=p(e,["components","mdxType","originalType","parentName"]),c=d(r),k=n,u=c["".concat(i,".").concat(k)]||c[k]||m[k]||o;return r?a.createElement(u,s(s({ref:t},l),{},{components:r})):a.createElement(u,s({ref:t},l))}));function u(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,s=new Array(o);s[0]=k;var p={};for(var i in t)hasOwnProperty.call(t,i)&&(p[i]=t[i]);p.originalType=e,p[c]="string"==typeof e?e:n,s[1]=p;for(var d=2;d{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>c,frontMatter:()=>o,metadata:()=>p,toc:()=>d});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.useTermsResponse",title:"Interface: useTermsResponse",sidebar_label:"@headstartwp/core.react.useTermsResponse",custom_edit_url:null},s=void 0,p={unversionedId:"interfaces/headstartwp_core.react.useTermsResponse",id:"interfaces/headstartwp_core.react.useTermsResponse",title:"Interface: useTermsResponse",description:"@headstartwp/core.react.useTermsResponse",source:"@site/docs/interfaces/headstartwp_core.react.useTermsResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.useTermsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.useTermsResponse",title:"Interface: useTermsResponse",sidebar_label:"@headstartwp/core.react.useTermsResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.useSearchResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse"},next:{title:"@headstartwp/next.FetchHookDataOptions",permalink:"/docs/api/interfaces/headstartwp_next.FetchHookDataOptions"}},i={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],l={toc:d};function c(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".useTermsResponse"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermEntity")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"useTermsResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"pageInfo")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"terms")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]")))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/useFetchTerms.ts#L15"},"packages/core/src/react/hooks/useFetchTerms.ts:15")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/37d12b40.41734cf0.js b/assets/js/37d12b40.41734cf0.js new file mode 100644 index 000000000..380aaad30 --- /dev/null +++ b/assets/js/37d12b40.41734cf0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[26],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>u});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function s(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var i=a.createContext({}),l=function(e){var t=a.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},d=function(e){var t=l(e.components);return a.createElement(i.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,i=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),c=l(r),k=n,u=c["".concat(i,".").concat(k)]||c[k]||m[k]||o;return r?a.createElement(u,s(s({ref:t},d),{},{components:r})):a.createElement(u,s({ref:t},d))}));function u(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,s=new Array(o);s[0]=k;var p={};for(var i in t)hasOwnProperty.call(t,i)&&(p[i]=t[i]);p.originalType=e,p[c]="string"==typeof e?e:n,s[1]=p;for(var l=2;l{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>c,frontMatter:()=>o,metadata:()=>p,toc:()=>l});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.useTermsResponse",title:"Interface: useTermsResponse",sidebar_label:"@headstartwp/core.react.useTermsResponse",custom_edit_url:null},s=void 0,p={unversionedId:"interfaces/headstartwp_core.react.useTermsResponse",id:"interfaces/headstartwp_core.react.useTermsResponse",title:"Interface: useTermsResponse",description:"@headstartwp/core.react.useTermsResponse",source:"@site/docs/interfaces/headstartwp_core.react.useTermsResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.useTermsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.useTermsResponse",title:"Interface: useTermsResponse",sidebar_label:"@headstartwp/core.react.useTermsResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.useSearchResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse"},next:{title:"@headstartwp/next.FetchHookDataOptions",permalink:"/docs/api/interfaces/headstartwp_next.FetchHookDataOptions"}},i={},l=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"mutate",id:"mutate",level:3},{value:"Defined in",id:"defined-in-4",level:4}],d={toc:l};function c(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".useTermsResponse"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermEntity")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"useTermsResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"pageInfo")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"terms")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]")))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetchTerms.ts#L16"},"packages/core/src/react/hooks/useFetchTerms.ts:16")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"mutate"},"mutate"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"mutate"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"KeyedMutator"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetchTerms.ts#L17"},"packages/core/src/react/hooks/useFetchTerms.ts:17")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/37ef8e6f.6ced10e5.js b/assets/js/37ef8e6f.00531137.js similarity index 99% rename from assets/js/37ef8e6f.6ced10e5.js rename to assets/js/37ef8e6f.00531137.js index 3daeb21f5..3fdfc40e0 100644 --- a/assets/js/37ef8e6f.6ced10e5.js +++ b/assets/js/37ef8e6f.00531137.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[228],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>h});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var o=a.createContext({}),p=function(e){var t=a.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=p(e.components);return a.createElement(o.Provider,{value:t},e.children)},m="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},c=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,o=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),m=p(n),c=i,h=m["".concat(o,".").concat(c)]||m[c]||k[c]||r;return n?a.createElement(h,l(l({ref:t},s),{},{components:n})):a.createElement(h,l({ref:t},s))}));function h(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,l=new Array(r);l[0]=c;var d={};for(var o in t)hasOwnProperty.call(t,o)&&(d[o]=t[o]);d.originalType=e,d[m]="string"==typeof e?e:i,l[1]=d;for(var p=2;p{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>m,frontMatter:()=>r,metadata:()=>d,toc:()=>p});var a=n(7462),i=(n(7294),n(3905));const r={id:"headstartwp_next.ImageProps",title:"Interface: ImageProps",sidebar_label:"@headstartwp/next.ImageProps",custom_edit_url:null},l=void 0,d={unversionedId:"interfaces/headstartwp_next.ImageProps",id:"interfaces/headstartwp_next.ImageProps",title:"Interface: ImageProps",description:"@headstartwp/next.ImageProps",source:"@site/docs/interfaces/headstartwp_next.ImageProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_next.ImageProps",permalink:"/docs/api/interfaces/headstartwp_next.ImageProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_next.ImageProps",title:"Interface: ImageProps",sidebar_label:"@headstartwp/next.ImageProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/next.FetchHookDataOptions",permalink:"/docs/api/interfaces/headstartwp_next.FetchHookDataOptions"},next:{title:"@headstartwp/next.LinkBlockProps",permalink:"/docs/api/interfaces/headstartwp_next.LinkBlockProps"}},o={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"alt",id:"alt",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"height",id:"height",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"linkDestination",id:"linkdestination",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"loader",id:"loader",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-8",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"sizeSlug",id:"sizeslug",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"src",id:"src",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"width",id:"width",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-13",level:4}],s={toc:p};function m(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next"},"@headstartwp/next"),".ImageProps"),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("inlineCode",{parentName:"p"},"ImageBlockProps")),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"ImageProps"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"alt"},"alt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"alt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.alt"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:9"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"attributes"},"attributes"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"attributes"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"align")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Align"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"border")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Border"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"colors")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Colors"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"spacing")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Spacing"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"typography")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Typography"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"width?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.attributes"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:70"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"children"},"children"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"children"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.children"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:69"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"classname"},"className"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"className"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.className"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:65"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"domnode"},"domNode"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"domNode"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Element")),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.domNode"),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:67"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"height"},"height"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"height"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.height"),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:5"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.htmlAnchor"),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:68"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"linkdestination"},"linkDestination"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"linkDestination"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.linkDestination"),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:7"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"loader"},"loader"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"loader"),": (",(0,i.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"ImageLoaderProps")," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#vipcustomimageloader"},(0,i.kt)("inlineCode",{parentName:"a"},"VIPCustomImageLoader")),") => ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,i.kt)("p",null,"\u25b8 (",(0,i.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h5",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"props")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"ImageLoaderProps")," ","|"," ",(0,i.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#vipcustomimageloader"},(0,i.kt)("inlineCode",{parentName:"a"},"VIPCustomImageLoader")))))),(0,i.kt)("h5",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/components/ImageComponent.tsx#L75"},"packages/next/src/components/ImageComponent.tsx:75")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"name"},"name"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"name"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.name"),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:64"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"sizeslug"},"sizeSlug"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"sizeSlug"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.sizeSlug"),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:6"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"src"},"src"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"src"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.src"),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:8"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"style"},"style"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"style"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.style"),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:66"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"width"},"width"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"width"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.width"),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:4"))}m.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[228],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>h});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var o=a.createContext({}),p=function(e){var t=a.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=p(e.components);return a.createElement(o.Provider,{value:t},e.children)},m="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},c=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,o=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),m=p(n),c=i,h=m["".concat(o,".").concat(c)]||m[c]||k[c]||r;return n?a.createElement(h,l(l({ref:t},s),{},{components:n})):a.createElement(h,l({ref:t},s))}));function h(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,l=new Array(r);l[0]=c;var d={};for(var o in t)hasOwnProperty.call(t,o)&&(d[o]=t[o]);d.originalType=e,d[m]="string"==typeof e?e:i,l[1]=d;for(var p=2;p{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>m,frontMatter:()=>r,metadata:()=>d,toc:()=>p});var a=n(7462),i=(n(7294),n(3905));const r={id:"headstartwp_next.ImageProps",title:"Interface: ImageProps",sidebar_label:"@headstartwp/next.ImageProps",custom_edit_url:null},l=void 0,d={unversionedId:"interfaces/headstartwp_next.ImageProps",id:"interfaces/headstartwp_next.ImageProps",title:"Interface: ImageProps",description:"@headstartwp/next.ImageProps",source:"@site/docs/interfaces/headstartwp_next.ImageProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_next.ImageProps",permalink:"/docs/api/interfaces/headstartwp_next.ImageProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_next.ImageProps",title:"Interface: ImageProps",sidebar_label:"@headstartwp/next.ImageProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/next.FetchHookDataOptions",permalink:"/docs/api/interfaces/headstartwp_next.FetchHookDataOptions"},next:{title:"@headstartwp/next.LinkBlockProps",permalink:"/docs/api/interfaces/headstartwp_next.LinkBlockProps"}},o={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"alt",id:"alt",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"height",id:"height",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"linkDestination",id:"linkdestination",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"loader",id:"loader",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-8",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"sizeSlug",id:"sizeslug",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"src",id:"src",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"width",id:"width",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-13",level:4}],s={toc:p};function m(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next"},"@headstartwp/next"),".ImageProps"),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("inlineCode",{parentName:"p"},"ImageBlockProps")),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"ImageProps"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"alt"},"alt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"alt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.alt"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:9"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"attributes"},"attributes"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"attributes"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"align")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Align"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"border")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Border"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"colors")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Colors"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"spacing")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Spacing"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"typography")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Typography"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"width?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.attributes"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:70"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"children"},"children"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"children"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.children"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:69"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"classname"},"className"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"className"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.className"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:65"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"domnode"},"domNode"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"domNode"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Element")),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.domNode"),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:67"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"height"},"height"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"height"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.height"),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:5"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.htmlAnchor"),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:68"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"linkdestination"},"linkDestination"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"linkDestination"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.linkDestination"),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:7"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"loader"},"loader"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"loader"),": (",(0,i.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"ImageLoaderProps")," ","|"," ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#vipcustomimageloader"},(0,i.kt)("inlineCode",{parentName:"a"},"VIPCustomImageLoader")),") => ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,i.kt)("p",null,"\u25b8 (",(0,i.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h5",{id:"parameters"},"Parameters"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"props")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"ImageLoaderProps")," ","|"," ",(0,i.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#vipcustomimageloader"},(0,i.kt)("inlineCode",{parentName:"a"},"VIPCustomImageLoader")))))),(0,i.kt)("h5",{id:"returns"},"Returns"),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/components/ImageComponent.tsx#L75"},"packages/next/src/components/ImageComponent.tsx:75")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"name"},"name"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"name"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.name"),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:64"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"sizeslug"},"sizeSlug"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"sizeSlug"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.sizeSlug"),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:6"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"src"},"src"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"src"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.src"),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:8"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"style"},"style"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"style"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.style"),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:66"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"width"},"width"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"width"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,"ImageBlockProps.width"),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/ImageBlock.d.ts:4"))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/38f0e7b9.60c98f59.js b/assets/js/38f0e7b9.547e607a.js similarity index 94% rename from assets/js/38f0e7b9.60c98f59.js rename to assets/js/38f0e7b9.547e607a.js index 94249723a..8420f3590 100644 --- a/assets/js/38f0e7b9.60c98f59.js +++ b/assets/js/38f0e7b9.547e607a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2254],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var d=r.createContext({}),s=function(e){var t=r.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},o=function(e){var t=s(e.components);return r.createElement(d.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,d=e.parentName,o=p(e,["components","mdxType","originalType","parentName"]),c=s(a),m=n,h=c["".concat(d,".").concat(m)]||c[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},o),{},{components:a})):r.createElement(h,l({ref:t},o))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p[c]="string"==typeof e?e:n,l[1]=p;for(var s=2;s{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>p,toc:()=>s});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.SinglePostFetchStrategy",title:"Class: SinglePostFetchStrategy",sidebar_label:"@headstartwp/core.SinglePostFetchStrategy",custom_edit_url:null},l=void 0,p={unversionedId:"classes/headstartwp_core.SinglePostFetchStrategy",id:"classes/headstartwp_core.SinglePostFetchStrategy",title:"Class: SinglePostFetchStrategy",description:"@headstartwp/core.SinglePostFetchStrategy",source:"@site/docs/classes/headstartwp_core.SinglePostFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.SinglePostFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.SinglePostFetchStrategy",title:"Class: SinglePostFetchStrategy",sidebar_label:"@headstartwp/core.SinglePostFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.SearchNativeFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.SearchNativeFetchStrategy"},next:{title:"@headstartwp/core.TaxonomyTermsStrategy",permalink:"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy"}},d={},s=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"locale",id:"locale",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"path",id:"path",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"postType",id:"posttype",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"revision",id:"revision",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"shouldCheckCurrentPathAgainstPostLink",id:"shouldcheckcurrentpathagainstpostlink",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Overrides",id:"overrides-4",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-5",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"getPostThatMatchesCurrentPath",id:"getpostthatmatchescurrentpath",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"getPreviewAuthHeader",id:"getpreviewauthheader",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"getPreviewHeaderName",id:"getpreviewheadername",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Overrides",id:"overrides-6",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-27",level:4}],o={toc:s};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".SinglePostFetchStrategy"),(0,n.kt)("p",null,"The SinglePostFetchStrategy is used to fetch a single post entity from any post type.\nNote that custom post types should be defined in ",(0,n.kt)("inlineCode",{parentName:"p"},"headless.config.js")),(0,n.kt)("p",null,"This strategy supports extracting endpoint params from url E.g:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/post-name")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ slug: 'post-name'}")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/2021/10/20/post-name")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ year: 2021, month: 10, day: 20, slug: 'post-name }")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/2021/")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ year: 2021, slug: 'post-name' }"))),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"See"))),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy#getparamsfromurl"},"getParamsFromURL")," to learn about url param mapping"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"SinglePostFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new SinglePostFetchStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams")))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L143"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:143")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L119"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:119")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L124"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:124")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"locale"},"locale"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"locale"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L89"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:89")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"path"},"path"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"path"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L87"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:87")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"posttype"},"postType"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"postType"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"'post'")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L83"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:83")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"revision"},"revision"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"revision"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L85"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:85")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"shouldcheckcurrentpathagainstpostlink"},"shouldCheckCurrentPathAgainstPostLink"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"shouldCheckCurrentPathAgainstPostLink"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"true")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L91"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:91")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Handlers post types, revisions and fetching by id"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint url")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L127"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:127")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("p",null,"Handles fetching by multiple post types, authToken and revisions"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The url to fetch")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint url")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"FetchOptions")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L275"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:275")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"filterOptions?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"filterOptions?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"overrides-2"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L338"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:338")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L442"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:442")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L256"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:256")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L407"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:407")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides-3"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L93"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:93")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides-4"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L97"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:97")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L174"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:174")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Returns the supported params from the URL if present."),(0,n.kt)("p",null,"These params are passed to ",(0,n.kt)("inlineCode",{parentName:"p"},"buildEndpointURL"),". If the strategy does not support\nmapping url params to endpoint params, it should return an empty object."),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The Path name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"params extracted from the URL"),(0,n.kt)("h4",{id:"overrides-5"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L102"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:102")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpostthatmatchescurrentpath"},"getPostThatMatchesCurrentPath"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPostThatMatchesCurrentPath"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"result"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"T")),(0,n.kt)("p",null,"Returns only the post that matches the current path"),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"result")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"T")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L166"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:166")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewauthheader"},"getPreviewAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getpreviewauthheader"},"getPreviewAuthHeader")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L247"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:247")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewheadername"},"getPreviewHeaderName"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewHeaderName"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getpreviewheadername"},"getPreviewHeaderName")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L241"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:241")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L365"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:365")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L205"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:205")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L417"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:417")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,n.kt)("p",null,"Prepares the post response"),(0,n.kt)("h4",{id:"parameters-14"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-16"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,n.kt)("h4",{id:"overrides-6"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L205"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:205")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-15"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-17"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L164"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:164")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-16"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-18"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2254],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>c});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var s=r.createContext({}),d=function(e){var t=r.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},o=function(e){var t=d(e.components);return r.createElement(s.Provider,{value:t},e.children)},k="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,s=e.parentName,o=p(e,["components","mdxType","originalType","parentName"]),k=d(a),h=n,c=k["".concat(s,".").concat(h)]||k[h]||m[h]||i;return a?r.createElement(c,l(l({ref:t},o),{},{components:a})):r.createElement(c,l({ref:t},o))}));function c(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=h;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[k]="string"==typeof e?e:n,l[1]=p;for(var d=2;d{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>k,frontMatter:()=>i,metadata:()=>p,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.SinglePostFetchStrategy",title:"Class: SinglePostFetchStrategy",sidebar_label:"@headstartwp/core.SinglePostFetchStrategy",custom_edit_url:null},l=void 0,p={unversionedId:"classes/headstartwp_core.SinglePostFetchStrategy",id:"classes/headstartwp_core.SinglePostFetchStrategy",title:"Class: SinglePostFetchStrategy",description:"@headstartwp/core.SinglePostFetchStrategy",source:"@site/docs/classes/headstartwp_core.SinglePostFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.SinglePostFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.SinglePostFetchStrategy",title:"Class: SinglePostFetchStrategy",sidebar_label:"@headstartwp/core.SinglePostFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.SearchNativeFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.SearchNativeFetchStrategy"},next:{title:"@headstartwp/core.TaxonomyTermsStrategy",permalink:"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy"}},s={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"locale",id:"locale",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"path",id:"path",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"postType",id:"posttype",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"revision",id:"revision",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"shouldCheckCurrentPathAgainstPostLink",id:"shouldcheckcurrentpathagainstpostlink",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Overrides",id:"overrides-4",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-5",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"getPostThatMatchesCurrentPath",id:"getpostthatmatchescurrentpath",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"getPreviewAuthHeader",id:"getpreviewauthheader",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"getPreviewHeaderName",id:"getpreviewheadername",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Overrides",id:"overrides-6",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-27",level:4}],o={toc:d};function k(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".SinglePostFetchStrategy"),(0,n.kt)("p",null,"The SinglePostFetchStrategy is used to fetch a single post entity from any post type.\nNote that custom post types should be defined in ",(0,n.kt)("inlineCode",{parentName:"p"},"headless.config.js")),(0,n.kt)("p",null,"This strategy supports extracting endpoint params from url E.g:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/post-name")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ slug: 'post-name'}")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/2021/10/20/post-name")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ year: 2021, month: 10, day: 20, slug: 'post-name }")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/2021/")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ year: 2021, slug: 'post-name' }"))),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"See"))),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy#getparamsfromurl"},"getParamsFromURL")," to learn about url param mapping"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"SinglePostFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new SinglePostFetchStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams")))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L143"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:143")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L119"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:119")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L124"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:124")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"locale"},"locale"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"locale"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L89"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:89")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"path"},"path"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"path"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L87"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:87")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"posttype"},"postType"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"postType"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"'post'")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L83"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:83")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"revision"},"revision"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"revision"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L85"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:85")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"shouldcheckcurrentpathagainstpostlink"},"shouldCheckCurrentPathAgainstPostLink"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"shouldCheckCurrentPathAgainstPostLink"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"true")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L91"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:91")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Handlers post types, revisions and fetching by id"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint url")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L127"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:127")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("p",null,"Handles fetching by multiple post types, authToken and revisions"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The url to fetch")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint url")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"FetchOptions")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L275"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:275")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"filterOptions?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"filterOptions?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"overrides-2"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L338"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:338")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L442"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:442")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L256"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:256")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L407"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:407")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides-3"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L93"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:93")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides-4"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L97"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:97")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L174"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:174")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Returns the supported params from the URL if present."),(0,n.kt)("p",null,"These params are passed to ",(0,n.kt)("inlineCode",{parentName:"p"},"buildEndpointURL"),". If the strategy does not support\nmapping url params to endpoint params, it should return an empty object."),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The Path name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"params extracted from the URL"),(0,n.kt)("h4",{id:"overrides-5"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L102"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:102")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpostthatmatchescurrentpath"},"getPostThatMatchesCurrentPath"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPostThatMatchesCurrentPath"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"result"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"T")),(0,n.kt)("p",null,"Returns only the post that matches the current path"),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"result")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"T")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L166"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:166")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewauthheader"},"getPreviewAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getpreviewauthheader"},"getPreviewAuthHeader")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L247"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:247")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewheadername"},"getPreviewHeaderName"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewHeaderName"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getpreviewheadername"},"getPreviewHeaderName")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L241"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:241")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L365"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:365")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L205"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:205")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L417"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:417")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,n.kt)("p",null,"Prepares the post response"),(0,n.kt)("h4",{id:"parameters-14"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-16"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,n.kt)("h4",{id:"overrides-6"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L205"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:205")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-15"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-17"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L164"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:164")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-16"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-18"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/3b216a90.e1bccbd8.js b/assets/js/3b216a90.c8a621d1.js similarity index 99% rename from assets/js/3b216a90.e1bccbd8.js rename to assets/js/3b216a90.c8a621d1.js index b0dfda9a9..7a1cdd39a 100644 --- a/assets/js/3b216a90.e1bccbd8.js +++ b/assets/js/3b216a90.c8a621d1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8989],{3905:(e,t,a)=>{a.d(t,{Zo:()=>h,kt:()=>g});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function s(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var l=n.createContext({}),p=function(e){var t=n.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):s(s({},t),e)),a},h=function(e){var t=p(e.components);return n.createElement(l.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},c=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,o=e.originalType,l=e.parentName,h=i(e,["components","mdxType","originalType","parentName"]),d=p(a),c=r,g=d["".concat(l,".").concat(c)]||d[c]||u[c]||o;return a?n.createElement(g,s(s({ref:t},h),{},{components:a})):n.createElement(g,s({ref:t},h))}));function g(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=a.length,s=new Array(o);s[0]=c;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[d]="string"==typeof e?e:r,s[1]=i;for(var p=2;p{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var n=a(7462),r=(a(7294),a(3905));const o={slug:"/getting-started/quick-tutorial"},s="Quick Introduction to the Framework",i={unversionedId:"Getting Started/quick-tutorial",id:"Getting Started/quick-tutorial",title:"Quick Introduction to the Framework",description:"Introduction",source:"@site/documentation/01-Getting Started/quick-tutorial.md",sourceDirName:"01-Getting Started",slug:"/getting-started/quick-tutorial",permalink:"/docs/learn/getting-started/quick-tutorial",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/01-Getting Started/quick-tutorial.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",frontMatter:{slug:"/getting-started/quick-tutorial"},sidebar:"tutorialSidebar",previous:{title:"Installing WordPress Plugin",permalink:"/docs/learn/getting-started/installing-wordpress-plugin"},next:{title:"Introduction",permalink:"/docs/learn/data-fetching"}},l={},p=[{value:"Introduction",id:"introduction",level:2},{value:"How Routing Works",id:"how-routing-works",level:2},{value:"Basic Data Fetching",id:"basic-data-fetching",level:3},{value:"Main Query, Queried Object, and SEO handling.",id:"main-query-queried-object-and-seo-handling",level:2},{value:"Should you handle loading/error states on the client?",id:"should-you-handle-loadingerror-states-on-the-client",level:2}],h={toc:p};function d(e){let{components:t,...o}=e;return(0,r.kt)("wrapper",(0,n.Z)({},h,o,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"quick-introduction-to-the-framework"},"Quick Introduction to the Framework"),(0,r.kt)("h2",{id:"introduction"},"Introduction"),(0,r.kt)("p",null,"If you\u2019re familiar with Next.js you probably already know that it has a file-system-based router. The routes are declared under the ",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages")," folder. To learn more about Next.js routing, read the ",(0,r.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/routing/introduction"},"official docs"),"."),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},"the ",(0,r.kt)("inlineCode",{parentName:"p"},"app")," folder is currently not supported by HeadstartWP. Support for new Next.js 13 features, including the app directory, are underway.")),(0,r.kt)("p",null,"HeadstartWP takes advantage of Next.js routing by leveraging a feature called \u201ccatch-all routes\u201d which allows the framework to automatically map URL segments to WordPress routes and the proper REST API parameters necessary to fetch the appropriate data. It does so by adopting a convention of using a \u201ccatch-all\u201d route named ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"[[...path]].js"),"."),(0,r.kt)("h2",{id:"how-routing-works"},"How Routing Works"),(0,r.kt)("p",null,"To understand how routing works in the framework, let\u2019s take a look at the route in the starter project (",(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/develop/projects/wp-nextjs/src/pages/%5B...path%5D.js"},"src/pages/[...path].js"),") that corresponds to a single post/page template (single.php) in WordPress."),(0,r.kt)("p",null,"First, note that it is using single brackets and not double brackets. That is because we only want to \u201ccatch\u201d that route if no other top-level route is matched (such as ",(0,r.kt)("inlineCode",{parentName:"p"},"index.js"),"). Therefore, any route in the form of /post-name or /2022/10/1 will match ",(0,r.kt)("inlineCode",{parentName:"p"},"src/[...path].js"),". You can confirm this by opening any post by either the /post-name route or the date route depending on how your permalinks settings are set up in WordPress E.g:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://headless-framework.vercel.app/2020/05/07/distinctio-rerum-ratione-maxime-repudiandae-laboriosam-quam"},"https://headless-framework.vercel.app/2020/05/07/distinctio-rerum-ratione-maxime-repudiandae-laboriosam-quam")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://headless-framework.vercel.app/distinctio-rerum-ratione-maxime-repudiandae-laboriosam-quam"},"https://headless-framework.vercel.app/distinctio-rerum-ratione-maxime-repudiandae-laboriosam-quam"))),(0,r.kt)("p",null,"The great thing about this is that you don\u2019t need multiple Next.js routes to handle the same resource!"),(0,r.kt)("h3",{id:"basic-data-fetching"},"Basic Data Fetching"),(0,r.kt)("p",null,"Now let\u2019s look at how data fetching for this route works. To make things easier to understand, let\u2019s disregard ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticPaths")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticProps")," functions."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/params.js"',title:'"src/params.js"'},"/**\n * @type {import('@headstartwp/core').PostParams}\n */\nexport const singleParams = { postType: ['page', 'post'] };\n")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/[...path].js"',title:'"src/pages/[...path].js"'},"import { usePost } from '@headstartwp/next';\n\nconst SinglePostsPage = () => {\n const { loading, error } = usePost(singleParams);\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n \n
\n );\n};\n")),(0,r.kt)("p",null,"At this point, the page is not rendered on the server (or at build time) at all. Therefore this route is behaving like a single-page application."),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," hook is one of the framework's data-fetching hooks. As its name suggests it fetches a single post for a given set of params. We\u2019re passing one param called ",(0,r.kt)("inlineCode",{parentName:"p"},"postType"),', which is telling the hook to fetch the current page from either the "page" or "post" post type. Note that we\'re not passing the slug. Passing the slug is optional and if you don\'t pass the slug, the framework will automatically extract the post/page slug from the URL, if present.'),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},"Extracting the ",(0,r.kt)("em",{parentName:"p"},"slug")," from the url ",(0,r.kt)("strong",{parentName:"p"},"only")," works when using the ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"[[...path]].js "),"catch-all route style.")),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"SPA Data Fetching",src:a(2890).Z,width:"1900",height:"817"})),(0,r.kt)("p",null,"Without server-side data fetching, the experience gets clunky and web vitals are greatly affected as there will be a high CLS. SEO is also affected since there is no content or SEO meta tags until the browser fetches the data."),(0,r.kt)("p",null,"The framework data fetching layer is \u201cisomorphic\u201d, you start with client-side data fetching and then opt-in for data that must be pre-fetched on the server. There are a few benefits of this approach:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"It\u2019s possible to easily switch between pre-fetched and non-prefetched data"),(0,r.kt)("li",{parentName:"ul"},'You can pre-fetch on the server and re-fetch on the client, for instance, you might want to re-fetch the "most recent posts" block on the homepage.'),(0,r.kt)("li",{parentName:"ul"},"Mitigate prop-drilling, no need to pass post props to every component as you can simply call the custom hooks (as long as the params match what's being queried for).")),(0,r.kt)("p",null,"It is important to note that ",(0,r.kt)("strong",{parentName:"p"},"you should always pre-fetch on the server the \u201cmain query\u201d and/or the \u201ccore\u201d data for a page in a headless site"),". That\u2019s what we\u2019ll do next! Keep the ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticPaths")," function commented out and uncomment ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticProps"),"."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/[...path].js"',title:'"src/pages/[...path].js"'},"export async function getStaticProps(context) {\n try {\n\n const settledPromises = await resolveBatch([\n {\n func: fetchHookData(usePost.fetcher(), context, { params: singleParams }),\n },\n { func: fetchHookData(useAppSettings.fetcher(), context), throw: false },\n ]);\n\n return addHookData(settledPromises, { revalidate: 5 * 60 });\n } catch (e) {\n return handleError(e, context);\n }\n}\n")),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"getStaticProps")," is a Next.js method used when you want to pre-render a page on the server at build time or ",(0,r.kt)("a",{parentName:"p",href:"https://nextjs.org/learn/basic-features/data-fetching/incremental-static-regeneration"},"on-demand via ISR"),"."),(0,r.kt)("p",null,"To enable pre-rendering of this route all we need to do is pre-fetch all of the data needed for the framework\u2019s custom hooks. There are two hooks we need to pre-fetch data for, ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"useAppSettings"),". The ",(0,r.kt)("inlineCode",{parentName:"p"},"useAppSettings")," hook is responsible for fetching general settings and menu data. The Nav.js component depends on ",(0,r.kt)("inlineCode",{parentName:"p"},"useAppSettings")," and if we don\u2019t pre-fetch data for it, the menu will be fetched on the client side only."),(0,r.kt)("p",null,"The function responsible for pre-fetching data is ",(0,r.kt)("inlineCode",{parentName:"p"},"fetchHookData"),". It accepts the following params:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"A fetcher strategy that you can get via ",(0,r.kt)("inlineCode",{parentName:"li"},"usePost.fetcher()")),(0,r.kt)("li",{parentName:"ul"},"The next.js context. It is used to extract parameters from the URL among other things."),(0,r.kt)("li",{parentName:"ul"},"An object containing the params. The params must match the params being used by the hooks, otherwise, there will be a key mismatch and data would be pre-fetched for the wrong set of params.")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"resolveBatch")," function is just a utility function that lets you run multiple promises in parallel and select which ones you don\u2019t want to throw errors for. In this case, we\u2019re ignoring the error potentially thrown by ",(0,r.kt)("inlineCode",{parentName:"p"},"useAppSettings.fetcher()")," the reason being that this hook requires the Headless WordPress plugin, and therefore disabling that plugin would cause a crash on the site if we don\u2019t ignore errors thrown by ",(0,r.kt)("inlineCode",{parentName:"p"},"useAppSettings.fetcher()"),". Ultimately, it is up to your to decide how to handle errors, we just give you the tools to make your job easier."),(0,r.kt)("p",null,"Next, we have the ",(0,r.kt)("inlineCode",{parentName:"p"},"addHookData"),' function which expects an array of "hook data" (i.e pre-fetched data for the custom hooks returned by ',(0,r.kt)("inlineCode",{parentName:"p"},"fetchHookData"),"). The ",(0,r.kt)("inlineCode",{parentName:"p"},"addHookData")," will simply put the results on the cache and hydrate the custom hook with pre-fetched data. The second param is an object that represents the Next.js props you can return from ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticProps")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"getServerSideProps"),"."),(0,r.kt)("p",null,"If anything fails, we call the ",(0,r.kt)("inlineCode",{parentName:"p"},"handleError")," function which provides standard error handling such as rendering a 404 page if a page is not found and optionally handling redirects (if the redirect strategy is set to 404 in headstartwp.config.js)."),(0,r.kt)("p",null,"Lastly, the ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticPaths")," will return an array of paths that should be pre-rendered at build time. This should only be used in conjunction with getStaticProps. Note that the framework doesn\u2019t force getStaticProps you can use getServerSideProps (especially if your hosting doesn\u2019t provide good support for ISR)."),(0,r.kt)("p",null,"One benefit of pre-rendering (a subset of your pages) at build time is that it can catch a lot of runtime issues since undefined/type errors among others would be caught at build time in your CI."),(0,r.kt)("h2",{id:"main-query-queried-object-and-seo-handling"},"Main Query, Queried Object, and SEO handling."),(0,r.kt)("p",null,"At this point, you might be wondering how the framework handles SEO integration. It does so by using the ",(0,r.kt)("inlineCode",{parentName:"p"},"yoast_head")," (or ",(0,r.kt)("inlineCode",{parentName:"p"},"yoast_head_json")," object) added by the Yoast plugin to every resource in the REST API. It works for both single pages and archive pages. The ",(0,r.kt)("inlineCode",{parentName:"p"},"yoast_head_json")," from either the main query or the queried object is used to populate the page\u2019s meta tags."),(0,r.kt)("p",null,'The "Main Query" is the query that draws parameters from the URL. For example, in ',(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/[...path].js"),", the usePost is the main query since it extracts parameters from the URL. Therefore the yoast_head_json associated with the resource returned by usePost is used to populate the page's SEO meta tags. This allows for additional data to be fetched with other custom hooks without messing with the SEO meta tags for the page."),(0,r.kt)("p",null,'For instance, you might want to display an array of related posts at the bottom of the single post template, since this doesn\u2019t represent the "main query" of the page it won\u2019t be used to populate the page\'s SEO meta tags.'),(0,r.kt)("p",null,'There\u2019s also the concept of "queried object" which is very similar to ',(0,r.kt)("a",{parentName:"p",href:"https://developer.wordpress.org/reference/functions/get_queried_object/"},"get_queried_object()"),' function in WP. It returns the resource that is being "queried for". For instance, in a category archive page, the queried object represents the category that\'s being queried for.'),(0,r.kt)("p",null,"Let's take a look at ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/develop/projects/wp-nextjs/src/pages/category/%5B...path%5D.js"},"src/pages/category/[...path].js")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/category/[...path].js"',title:'"src/pages/category/[...path].js"'},"import { usePosts } from '@headstartwp/next';\n\nconst CategoryPage = () => {\n const { data } = usePosts({ taxonomy: 'category' });\n\n return (\n <>\n

Category Page: {data.queriedObject.term.name}

\n
    \n {data.posts.map((post) => (\n
  • \n {post.title.rendered}\n
    • \n ))}\n
\n \n \n );\n};\n")),(0,r.kt)("p",null,"In this route, we're fetching a list of posts that belong to the category taxonomy. Note that again, we're not passing the category slug, it\u2019s automatically inferred by the framework."),(0,r.kt)("p",null,"Since we\u2019re querying posts that belong to a specific category, ",(0,r.kt)("inlineCode",{parentName:"p"},"data.queriedObject"),' is available with a term object representing the queried category. You will note that this route follows the same "pattern" from ',(0,r.kt)("inlineCode",{parentName:"p"},"src/[...path].js"),"."),(0,r.kt)("p",null,"Take some time to review the other routes, did you spot the pattern?"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"Fetch data on the client using the framework\u2019s custom hooks"),(0,r.kt)("li",{parentName:"ul"},"Pre-fetch the data on the server matching the params object.")),(0,r.kt)("h2",{id:"should-you-handle-loadingerror-states-on-the-client"},"Should you handle loading/error states on the client?"),(0,r.kt)("p",null,"As you might have noticed, the category route is not handling errors and loading states on the client. Therefore it assumes the data will always be pre-fetched on the server. If you remove ",(0,r.kt)("inlineCode",{parentName:"p"},"getServerSideProps"),", you will see the following error."),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"data-error",src:a(4499).Z,width:"1016",height:"479"})),(0,r.kt)("p",null,"At 10up, we strongly believe that a great developer experience increases developer productivity! Therefore the framework will try to help you, the developer, as much as it can."),(0,r.kt)("p",null,"In this case, it \"detects\" that you\u2019re trying to access something that's returned by the custom hook but is not yet available. As the error message suggests, you need to either handle the loading/error states or pre-fetch the data on the server. We didn't see this error on the single post route because loading/error states are being handled on that route!"),(0,r.kt)("p",null,"So as long as you're pre-fetching data on the server you do not need to handle loading/error states on the client."),(0,r.kt)("p",null,"One way to make things more consistent and your code more resilient without directly handling loading states is by using Suspense, however, that is not fully supported in Next.js and the framework itself (but it will!)."))}d.isMDXComponent=!0},4499:(e,t,a)=>{a.d(t,{Z:()=>n});const n=a.p+"assets/images/error-3ed1849400bc19eb2faa27512eef44c7.png"},2890:(e,t,a)=>{a.d(t,{Z:()=>n});const n=a.p+"assets/images/spa-data-fetching-1-57ac198c0190058bf0a30abfa7ccd060.gif"}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8989],{3905:(e,t,a)=>{a.d(t,{Zo:()=>h,kt:()=>g});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function s(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var l=n.createContext({}),p=function(e){var t=n.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):s(s({},t),e)),a},h=function(e){var t=p(e.components);return n.createElement(l.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},c=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,o=e.originalType,l=e.parentName,h=i(e,["components","mdxType","originalType","parentName"]),d=p(a),c=r,g=d["".concat(l,".").concat(c)]||d[c]||u[c]||o;return a?n.createElement(g,s(s({ref:t},h),{},{components:a})):n.createElement(g,s({ref:t},h))}));function g(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=a.length,s=new Array(o);s[0]=c;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[d]="string"==typeof e?e:r,s[1]=i;for(var p=2;p{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var n=a(7462),r=(a(7294),a(3905));const o={slug:"/getting-started/quick-tutorial"},s="Quick Introduction to the Framework",i={unversionedId:"Getting Started/quick-tutorial",id:"Getting Started/quick-tutorial",title:"Quick Introduction to the Framework",description:"Introduction",source:"@site/documentation/01-Getting Started/quick-tutorial.md",sourceDirName:"01-Getting Started",slug:"/getting-started/quick-tutorial",permalink:"/docs/learn/getting-started/quick-tutorial",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/01-Getting Started/quick-tutorial.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",frontMatter:{slug:"/getting-started/quick-tutorial"},sidebar:"tutorialSidebar",previous:{title:"Installing WordPress Plugin",permalink:"/docs/learn/getting-started/installing-wordpress-plugin"},next:{title:"Introduction",permalink:"/docs/learn/data-fetching"}},l={},p=[{value:"Introduction",id:"introduction",level:2},{value:"How Routing Works",id:"how-routing-works",level:2},{value:"Basic Data Fetching",id:"basic-data-fetching",level:3},{value:"Main Query, Queried Object, and SEO handling.",id:"main-query-queried-object-and-seo-handling",level:2},{value:"Should you handle loading/error states on the client?",id:"should-you-handle-loadingerror-states-on-the-client",level:2}],h={toc:p};function d(e){let{components:t,...o}=e;return(0,r.kt)("wrapper",(0,n.Z)({},h,o,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"quick-introduction-to-the-framework"},"Quick Introduction to the Framework"),(0,r.kt)("h2",{id:"introduction"},"Introduction"),(0,r.kt)("p",null,"If you\u2019re familiar with Next.js you probably already know that it has a file-system-based router. The routes are declared under the ",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages")," folder. To learn more about Next.js routing, read the ",(0,r.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/routing/introduction"},"official docs"),"."),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},"the ",(0,r.kt)("inlineCode",{parentName:"p"},"app")," folder is currently not supported by HeadstartWP. Support for new Next.js 13 features, including the app directory, are underway.")),(0,r.kt)("p",null,"HeadstartWP takes advantage of Next.js routing by leveraging a feature called \u201ccatch-all routes\u201d which allows the framework to automatically map URL segments to WordPress routes and the proper REST API parameters necessary to fetch the appropriate data. It does so by adopting a convention of using a \u201ccatch-all\u201d route named ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"[[...path]].js"),"."),(0,r.kt)("h2",{id:"how-routing-works"},"How Routing Works"),(0,r.kt)("p",null,"To understand how routing works in the framework, let\u2019s take a look at the route in the starter project (",(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/develop/projects/wp-nextjs/src/pages/%5B...path%5D.js"},"src/pages/[...path].js"),") that corresponds to a single post/page template (single.php) in WordPress."),(0,r.kt)("p",null,"First, note that it is using single brackets and not double brackets. That is because we only want to \u201ccatch\u201d that route if no other top-level route is matched (such as ",(0,r.kt)("inlineCode",{parentName:"p"},"index.js"),"). Therefore, any route in the form of /post-name or /2022/10/1 will match ",(0,r.kt)("inlineCode",{parentName:"p"},"src/[...path].js"),". You can confirm this by opening any post by either the /post-name route or the date route depending on how your permalinks settings are set up in WordPress E.g:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://headless-framework.vercel.app/2020/05/07/distinctio-rerum-ratione-maxime-repudiandae-laboriosam-quam"},"https://headless-framework.vercel.app/2020/05/07/distinctio-rerum-ratione-maxime-repudiandae-laboriosam-quam")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://headless-framework.vercel.app/distinctio-rerum-ratione-maxime-repudiandae-laboriosam-quam"},"https://headless-framework.vercel.app/distinctio-rerum-ratione-maxime-repudiandae-laboriosam-quam"))),(0,r.kt)("p",null,"The great thing about this is that you don\u2019t need multiple Next.js routes to handle the same resource!"),(0,r.kt)("h3",{id:"basic-data-fetching"},"Basic Data Fetching"),(0,r.kt)("p",null,"Now let\u2019s look at how data fetching for this route works. To make things easier to understand, let\u2019s disregard ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticPaths")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticProps")," functions."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/params.js"',title:'"src/params.js"'},"/**\n * @type {import('@headstartwp/core').PostParams}\n */\nexport const singleParams = { postType: ['page', 'post'] };\n")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/[...path].js"',title:'"src/pages/[...path].js"'},"import { usePost } from '@headstartwp/next';\n\nconst SinglePostsPage = () => {\n const { loading, error } = usePost(singleParams);\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n \n
\n );\n};\n")),(0,r.kt)("p",null,"At this point, the page is not rendered on the server (or at build time) at all. Therefore this route is behaving like a single-page application."),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," hook is one of the framework's data-fetching hooks. As its name suggests it fetches a single post for a given set of params. We\u2019re passing one param called ",(0,r.kt)("inlineCode",{parentName:"p"},"postType"),', which is telling the hook to fetch the current page from either the "page" or "post" post type. Note that we\'re not passing the slug. Passing the slug is optional and if you don\'t pass the slug, the framework will automatically extract the post/page slug from the URL, if present.'),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},"Extracting the ",(0,r.kt)("em",{parentName:"p"},"slug")," from the url ",(0,r.kt)("strong",{parentName:"p"},"only")," works when using the ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"[[...path]].js "),"catch-all route style.")),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"SPA Data Fetching",src:a(2890).Z,width:"1900",height:"817"})),(0,r.kt)("p",null,"Without server-side data fetching, the experience gets clunky and web vitals are greatly affected as there will be a high CLS. SEO is also affected since there is no content or SEO meta tags until the browser fetches the data."),(0,r.kt)("p",null,"The framework data fetching layer is \u201cisomorphic\u201d, you start with client-side data fetching and then opt-in for data that must be pre-fetched on the server. There are a few benefits of this approach:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"It\u2019s possible to easily switch between pre-fetched and non-prefetched data"),(0,r.kt)("li",{parentName:"ul"},'You can pre-fetch on the server and re-fetch on the client, for instance, you might want to re-fetch the "most recent posts" block on the homepage.'),(0,r.kt)("li",{parentName:"ul"},"Mitigate prop-drilling, no need to pass post props to every component as you can simply call the custom hooks (as long as the params match what's being queried for).")),(0,r.kt)("p",null,"It is important to note that ",(0,r.kt)("strong",{parentName:"p"},"you should always pre-fetch on the server the \u201cmain query\u201d and/or the \u201ccore\u201d data for a page in a headless site"),". That\u2019s what we\u2019ll do next! Keep the ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticPaths")," function commented out and uncomment ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticProps"),"."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/[...path].js"',title:'"src/pages/[...path].js"'},"export async function getStaticProps(context) {\n try {\n\n const settledPromises = await resolveBatch([\n {\n func: fetchHookData(usePost.fetcher(), context, { params: singleParams }),\n },\n { func: fetchHookData(useAppSettings.fetcher(), context), throw: false },\n ]);\n\n return addHookData(settledPromises, { revalidate: 5 * 60 });\n } catch (e) {\n return handleError(e, context);\n }\n}\n")),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"getStaticProps")," is a Next.js method used when you want to pre-render a page on the server at build time or ",(0,r.kt)("a",{parentName:"p",href:"https://nextjs.org/learn/basic-features/data-fetching/incremental-static-regeneration"},"on-demand via ISR"),"."),(0,r.kt)("p",null,"To enable pre-rendering of this route all we need to do is pre-fetch all of the data needed for the framework\u2019s custom hooks. There are two hooks we need to pre-fetch data for, ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"useAppSettings"),". The ",(0,r.kt)("inlineCode",{parentName:"p"},"useAppSettings")," hook is responsible for fetching general settings and menu data. The Nav.js component depends on ",(0,r.kt)("inlineCode",{parentName:"p"},"useAppSettings")," and if we don\u2019t pre-fetch data for it, the menu will be fetched on the client side only."),(0,r.kt)("p",null,"The function responsible for pre-fetching data is ",(0,r.kt)("inlineCode",{parentName:"p"},"fetchHookData"),". It accepts the following params:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"A fetcher strategy that you can get via ",(0,r.kt)("inlineCode",{parentName:"li"},"usePost.fetcher()")),(0,r.kt)("li",{parentName:"ul"},"The next.js context. It is used to extract parameters from the URL among other things."),(0,r.kt)("li",{parentName:"ul"},"An object containing the params. The params must match the params being used by the hooks, otherwise, there will be a key mismatch and data would be pre-fetched for the wrong set of params.")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"resolveBatch")," function is just a utility function that lets you run multiple promises in parallel and select which ones you don\u2019t want to throw errors for. In this case, we\u2019re ignoring the error potentially thrown by ",(0,r.kt)("inlineCode",{parentName:"p"},"useAppSettings.fetcher()")," the reason being that this hook requires the Headless WordPress plugin, and therefore disabling that plugin would cause a crash on the site if we don\u2019t ignore errors thrown by ",(0,r.kt)("inlineCode",{parentName:"p"},"useAppSettings.fetcher()"),". Ultimately, it is up to your to decide how to handle errors, we just give you the tools to make your job easier."),(0,r.kt)("p",null,"Next, we have the ",(0,r.kt)("inlineCode",{parentName:"p"},"addHookData"),' function which expects an array of "hook data" (i.e pre-fetched data for the custom hooks returned by ',(0,r.kt)("inlineCode",{parentName:"p"},"fetchHookData"),"). The ",(0,r.kt)("inlineCode",{parentName:"p"},"addHookData")," will simply put the results on the cache and hydrate the custom hook with pre-fetched data. The second param is an object that represents the Next.js props you can return from ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticProps")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"getServerSideProps"),"."),(0,r.kt)("p",null,"If anything fails, we call the ",(0,r.kt)("inlineCode",{parentName:"p"},"handleError")," function which provides standard error handling such as rendering a 404 page if a page is not found and optionally handling redirects (if the redirect strategy is set to 404 in headstartwp.config.js)."),(0,r.kt)("p",null,"Lastly, the ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticPaths")," will return an array of paths that should be pre-rendered at build time. This should only be used in conjunction with getStaticProps. Note that the framework doesn\u2019t force getStaticProps you can use getServerSideProps (especially if your hosting doesn\u2019t provide good support for ISR)."),(0,r.kt)("p",null,"One benefit of pre-rendering (a subset of your pages) at build time is that it can catch a lot of runtime issues since undefined/type errors among others would be caught at build time in your CI."),(0,r.kt)("h2",{id:"main-query-queried-object-and-seo-handling"},"Main Query, Queried Object, and SEO handling."),(0,r.kt)("p",null,"At this point, you might be wondering how the framework handles SEO integration. It does so by using the ",(0,r.kt)("inlineCode",{parentName:"p"},"yoast_head")," (or ",(0,r.kt)("inlineCode",{parentName:"p"},"yoast_head_json")," object) added by the Yoast plugin to every resource in the REST API. It works for both single pages and archive pages. The ",(0,r.kt)("inlineCode",{parentName:"p"},"yoast_head_json")," from either the main query or the queried object is used to populate the page\u2019s meta tags."),(0,r.kt)("p",null,'The "Main Query" is the query that draws parameters from the URL. For example, in ',(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/[...path].js"),", the usePost is the main query since it extracts parameters from the URL. Therefore the yoast_head_json associated with the resource returned by usePost is used to populate the page's SEO meta tags. This allows for additional data to be fetched with other custom hooks without messing with the SEO meta tags for the page."),(0,r.kt)("p",null,'For instance, you might want to display an array of related posts at the bottom of the single post template, since this doesn\u2019t represent the "main query" of the page it won\u2019t be used to populate the page\'s SEO meta tags.'),(0,r.kt)("p",null,'There\u2019s also the concept of "queried object" which is very similar to ',(0,r.kt)("a",{parentName:"p",href:"https://developer.wordpress.org/reference/functions/get_queried_object/"},"get_queried_object()"),' function in WP. It returns the resource that is being "queried for". For instance, in a category archive page, the queried object represents the category that\'s being queried for.'),(0,r.kt)("p",null,"Let's take a look at ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/develop/projects/wp-nextjs/src/pages/category/%5B...path%5D.js"},"src/pages/category/[...path].js")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/category/[...path].js"',title:'"src/pages/category/[...path].js"'},"import { usePosts } from '@headstartwp/next';\n\nconst CategoryPage = () => {\n const { data } = usePosts({ taxonomy: 'category' });\n\n return (\n <>\n

Category Page: {data.queriedObject.term.name}

\n
    \n {data.posts.map((post) => (\n
  • \n {post.title.rendered}\n
    • \n ))}\n
\n \n \n );\n};\n")),(0,r.kt)("p",null,"In this route, we're fetching a list of posts that belong to the category taxonomy. Note that again, we're not passing the category slug, it\u2019s automatically inferred by the framework."),(0,r.kt)("p",null,"Since we\u2019re querying posts that belong to a specific category, ",(0,r.kt)("inlineCode",{parentName:"p"},"data.queriedObject"),' is available with a term object representing the queried category. You will note that this route follows the same "pattern" from ',(0,r.kt)("inlineCode",{parentName:"p"},"src/[...path].js"),"."),(0,r.kt)("p",null,"Take some time to review the other routes, did you spot the pattern?"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"Fetch data on the client using the framework\u2019s custom hooks"),(0,r.kt)("li",{parentName:"ul"},"Pre-fetch the data on the server matching the params object.")),(0,r.kt)("h2",{id:"should-you-handle-loadingerror-states-on-the-client"},"Should you handle loading/error states on the client?"),(0,r.kt)("p",null,"As you might have noticed, the category route is not handling errors and loading states on the client. Therefore it assumes the data will always be pre-fetched on the server. If you remove ",(0,r.kt)("inlineCode",{parentName:"p"},"getServerSideProps"),", you will see the following error."),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"data-error",src:a(4499).Z,width:"1016",height:"479"})),(0,r.kt)("p",null,"At 10up, we strongly believe that a great developer experience increases developer productivity! Therefore the framework will try to help you, the developer, as much as it can."),(0,r.kt)("p",null,"In this case, it \"detects\" that you\u2019re trying to access something that's returned by the custom hook but is not yet available. As the error message suggests, you need to either handle the loading/error states or pre-fetch the data on the server. We didn't see this error on the single post route because loading/error states are being handled on that route!"),(0,r.kt)("p",null,"So as long as you're pre-fetching data on the server you do not need to handle loading/error states on the client."),(0,r.kt)("p",null,"One way to make things more consistent and your code more resilient without directly handling loading states is by using Suspense, however, that is not fully supported in Next.js and the framework itself (but it will!)."))}d.isMDXComponent=!0},4499:(e,t,a)=>{a.d(t,{Z:()=>n});const n=a.p+"assets/images/error-3ed1849400bc19eb2faa27512eef44c7.png"},2890:(e,t,a)=>{a.d(t,{Z:()=>n});const n=a.p+"assets/images/spa-data-fetching-1-57ac198c0190058bf0a30abfa7ccd060.gif"}}]); \ No newline at end of file diff --git a/assets/js/3d28897f.47c4606f.js b/assets/js/3d28897f.351662ad.js similarity index 93% rename from assets/js/3d28897f.47c4606f.js rename to assets/js/3d28897f.351662ad.js index 252202c12..2d7f33ab3 100644 --- a/assets/js/3d28897f.47c4606f.js +++ b/assets/js/3d28897f.351662ad.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1552],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function p(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var s=a.createContext({}),l=function(e){var t=a.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},c=function(e){var t=l(e.components);return a.createElement(s.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,p=e.originalType,s=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),d=l(r),k=n,h=d["".concat(s,".").concat(k)]||d[k]||u[k]||p;return r?a.createElement(h,i(i({ref:t},c),{},{components:r})):a.createElement(h,i({ref:t},c))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var p=r.length,i=new Array(p);i[0]=k;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o[d]="string"==typeof e?e:n,i[1]=o;for(var l=2;l{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>d,frontMatter:()=>p,metadata:()=>o,toc:()=>l});var a=r(7462),n=(r(7294),r(3905));const p={id:"headstartwp_core.react.Typography",title:"Interface: Typography",sidebar_label:"@headstartwp/core.react.Typography",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.Typography",id:"interfaces/headstartwp_core.react.Typography",title:"Interface: Typography",description:"@headstartwp/core.react.Typography",source:"@site/docs/interfaces/headstartwp_core.react.Typography.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.Typography",permalink:"/docs/api/interfaces/headstartwp_core.react.Typography",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.Typography",title:"Interface: Typography",sidebar_label:"@headstartwp/core.react.Typography",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.TableBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps"},next:{title:"@headstartwp/core.react.VerseBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps"}},s={},l=[{value:"Properties",id:"properties",level:2},{value:"fontSize",id:"fontsize",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"letterSpacing",id:"letterspacing",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"lineHeight",id:"lineheight",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"supportsCustomFontSize",id:"supportscustomfontsize",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"supportsFontStyle",id:"supportsfontstyle",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"supportsFontWeight",id:"supportsfontweight",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"supportsLetterSpacing",id:"supportsletterspacing",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"supportsLineHeight",id:"supportslineheight",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"supportsTextDecoration",id:"supportstextdecoration",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"supportsTextTransform",id:"supportstexttransform",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"textTransform",id:"texttransform",level:3},{value:"Defined in",id:"defined-in-10",level:4}],c={toc:l};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".Typography"),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"fontsize"},"fontSize"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"fontSize"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"slug")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"value")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L24"},"packages/core/src/react/blocks/types.ts:24")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"letterspacing"},"letterSpacing"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"letterSpacing"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L37"},"packages/core/src/react/blocks/types.ts:37")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"lineheight"},"lineHeight"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"lineHeight"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L35"},"packages/core/src/react/blocks/types.ts:35")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"supportscustomfontsize"},"supportsCustomFontSize"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"supportsCustomFontSize"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L29"},"packages/core/src/react/blocks/types.ts:29")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"supportsfontstyle"},"supportsFontStyle"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"supportsFontStyle"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L28"},"packages/core/src/react/blocks/types.ts:28")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"supportsfontweight"},"supportsFontWeight"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"supportsFontWeight"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L30"},"packages/core/src/react/blocks/types.ts:30")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"supportsletterspacing"},"supportsLetterSpacing"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"supportsLetterSpacing"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L31"},"packages/core/src/react/blocks/types.ts:31")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"supportslineheight"},"supportsLineHeight"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"supportsLineHeight"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L32"},"packages/core/src/react/blocks/types.ts:32")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"supportstextdecoration"},"supportsTextDecoration"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"supportsTextDecoration"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L33"},"packages/core/src/react/blocks/types.ts:33")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"supportstexttransform"},"supportsTextTransform"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"supportsTextTransform"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L34"},"packages/core/src/react/blocks/types.ts:34")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"texttransform"},"textTransform"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"textTransform"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L36"},"packages/core/src/react/blocks/types.ts:36")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1552],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function p(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var s=a.createContext({}),l=function(e){var t=a.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},c=function(e){var t=l(e.components);return a.createElement(s.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,p=e.originalType,s=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),d=l(r),k=n,h=d["".concat(s,".").concat(k)]||d[k]||u[k]||p;return r?a.createElement(h,i(i({ref:t},c),{},{components:r})):a.createElement(h,i({ref:t},c))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var p=r.length,i=new Array(p);i[0]=k;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o[d]="string"==typeof e?e:n,i[1]=o;for(var l=2;l{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>d,frontMatter:()=>p,metadata:()=>o,toc:()=>l});var a=r(7462),n=(r(7294),r(3905));const p={id:"headstartwp_core.react.Typography",title:"Interface: Typography",sidebar_label:"@headstartwp/core.react.Typography",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.Typography",id:"interfaces/headstartwp_core.react.Typography",title:"Interface: Typography",description:"@headstartwp/core.react.Typography",source:"@site/docs/interfaces/headstartwp_core.react.Typography.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.Typography",permalink:"/docs/api/interfaces/headstartwp_core.react.Typography",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.Typography",title:"Interface: Typography",sidebar_label:"@headstartwp/core.react.Typography",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.TableBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps"},next:{title:"@headstartwp/core.react.VerseBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps"}},s={},l=[{value:"Properties",id:"properties",level:2},{value:"fontSize",id:"fontsize",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"letterSpacing",id:"letterspacing",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"lineHeight",id:"lineheight",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"supportsCustomFontSize",id:"supportscustomfontsize",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"supportsFontStyle",id:"supportsfontstyle",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"supportsFontWeight",id:"supportsfontweight",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"supportsLetterSpacing",id:"supportsletterspacing",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"supportsLineHeight",id:"supportslineheight",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"supportsTextDecoration",id:"supportstextdecoration",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"supportsTextTransform",id:"supportstexttransform",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"textTransform",id:"texttransform",level:3},{value:"Defined in",id:"defined-in-10",level:4}],c={toc:l};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".Typography"),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"fontsize"},"fontSize"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"fontSize"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"slug")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"value")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L24"},"packages/core/src/react/blocks/types.ts:24")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"letterspacing"},"letterSpacing"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"letterSpacing"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L37"},"packages/core/src/react/blocks/types.ts:37")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"lineheight"},"lineHeight"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"lineHeight"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L35"},"packages/core/src/react/blocks/types.ts:35")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"supportscustomfontsize"},"supportsCustomFontSize"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"supportsCustomFontSize"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L29"},"packages/core/src/react/blocks/types.ts:29")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"supportsfontstyle"},"supportsFontStyle"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"supportsFontStyle"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L28"},"packages/core/src/react/blocks/types.ts:28")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"supportsfontweight"},"supportsFontWeight"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"supportsFontWeight"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L30"},"packages/core/src/react/blocks/types.ts:30")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"supportsletterspacing"},"supportsLetterSpacing"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"supportsLetterSpacing"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L31"},"packages/core/src/react/blocks/types.ts:31")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"supportslineheight"},"supportsLineHeight"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"supportsLineHeight"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L32"},"packages/core/src/react/blocks/types.ts:32")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"supportstextdecoration"},"supportsTextDecoration"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"supportsTextDecoration"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L33"},"packages/core/src/react/blocks/types.ts:33")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"supportstexttransform"},"supportsTextTransform"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"supportsTextTransform"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L34"},"packages/core/src/react/blocks/types.ts:34")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"texttransform"},"textTransform"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"textTransform"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L36"},"packages/core/src/react/blocks/types.ts:36")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/44b9bd65.07c2630f.js b/assets/js/44b9bd65.07c2630f.js deleted file mode 100644 index e96538a35..000000000 --- a/assets/js/44b9bd65.07c2630f.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3126],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>u});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var d=n.createContext({}),o=function(e){var t=n.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},s=function(e){var t=o(e.components);return n.createElement(d.Provider,{value:t},e.children)},k="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},N=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),k=o(a),N=r,u=k["".concat(d,".").concat(N)]||k[N]||m[N]||i;return a?n.createElement(u,p(p({ref:t},s),{},{components:a})):n.createElement(u,p({ref:t},s))}));function u(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,p=new Array(i);p[0]=N;var l={};for(var d in t)hasOwnProperty.call(t,d)&&(l[d]=t[d]);l.originalType=e,l[k]="string"==typeof e?e:r,p[1]=l;for(var o=2;o{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>p,default:()=>k,frontMatter:()=>i,metadata:()=>l,toc:()=>o});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_next",title:"Module: @headstartwp/next",sidebar_label:"@headstartwp/next",sidebar_position:0,custom_edit_url:null},p=void 0,l={unversionedId:"modules/headstartwp_next",id:"modules/headstartwp_next",title:"Module: @headstartwp/next",description:"Namespaces",source:"@site/docs/modules/headstartwp_next.md",sourceDirName:"modules",slug:"/modules/headstartwp_next",permalink:"/docs/api/modules/headstartwp_next",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"headstartwp_next",title:"Module: @headstartwp/next",sidebar_label:"@headstartwp/next",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core",permalink:"/docs/api/modules/headstartwp_core"},next:{title:"@headstartwp/core.react",permalink:"/docs/api/namespaces/headstartwp_core.react"}},d={},o=[{value:"Namespaces",id:"namespaces",level:2},{value:"Interfaces",id:"interfaces",level:2},{value:"API handlers",id:"api-handlers",level:2},{value:"previewHandler",id:"previewhandler",level:3},{value:"Usage",id:"usage",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"revalidateHandler",id:"revalidatehandler",level:3},{value:"Usage",id:"usage-1",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"Data Fetching Hooks",id:"data-fetching-hooks",level:2},{value:"useAppSettings",id:"useappsettings",level:3},{value:"Usage",id:"usage-2",level:4},{value:"Server-Side-Rendering or Static-Site-Generation",id:"server-side-rendering-or-static-site-generation",level:5},{value:"Type parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"useAuthorArchive",id:"useauthorarchive",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"useMenu",id:"usemenu",level:3},{value:"Usage",id:"usage-3",level:4},{value:"Basic usage",id:"basic-usage",level:3},{value:"Re-fetching client-side on focus and/or mount",id:"re-fetching-client-side-on-focus-andor-mount",level:5},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"usePost",id:"usepost",level:3},{value:"Type parameters",id:"type-parameters-2",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"usePostOrPosts",id:"usepostorposts",level:3},{value:"Type parameters",id:"type-parameters-3",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"usePosts",id:"useposts",level:3},{value:"Handling multiple WordPress routes in a single next.js route",id:"handling-multiple-wordpress-routes-in-a-single-nextjs-route",level:4},{value:"Type parameters",id:"type-parameters-4",level:4},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"useSearch",id:"usesearch",level:3},{value:"Type parameters",id:"type-parameters-5",level:4},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"useSearchNative",id:"usesearchnative",level:3},{value:"Type parameters",id:"type-parameters-6",level:4},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"useSeo",id:"useseo",level:3},{value:"Usage",id:"usage-4",level:4},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"useTerms",id:"useterms",level:3},{value:"Usage",id:"usage-5",level:4},{value:"Type parameters",id:"type-parameters-7",level:4},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"Next.js Data Fetching Utilities",id:"nextjs-data-fetching-utilities",level:2},{value:"addHookData",id:"addhookdata",level:3},{value:"Usage",id:"usage-6",level:4},{value:"Type parameters",id:"type-parameters-8",level:4},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"convertToPath",id:"converttopath",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"fetchHookData",id:"fetchhookdata",level:3},{value:"Usage",id:"usage-7",level:4},{value:"Type parameters",id:"type-parameters-9",level:4},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"handleError",id:"handleerror",level:3},{value:"Usage",id:"usage-8",level:4},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"Other",id:"other",level:2},{value:"HeadlessAppProps",id:"headlessappprops",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"HeadlessGetServerSideProps",id:"headlessgetserversideprops",level:3},{value:"Type parameters",id:"type-parameters-10",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"HeadlessGetServerSidePropsContext",id:"headlessgetserversidepropscontext",level:3},{value:"Type parameters",id:"type-parameters-11",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"HeadlessGetStaticProps",id:"headlessgetstaticprops",level:3},{value:"Type parameters",id:"type-parameters-12",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"HeadlessGetStaticPropsPropsContext",id:"headlessgetstaticpropspropscontext",level:3},{value:"Type parameters",id:"type-parameters-13",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"HookState",id:"hookstate",level:3},{value:"Type parameters",id:"type-parameters-14",level:4},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"NextJSProps",id:"nextjsprops",level:3},{value:"Type parameters",id:"type-parameters-15",level:4},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"PreviewData",id:"previewdata",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"PreviewHandlerOptions",id:"previewhandleroptions",level:3},{value:"Type declaration",id:"type-declaration-4",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"VIPCustomImageLoader",id:"vipcustomimageloader",level:3},{value:"Defined in",id:"defined-in-27",level:4},{value:"seoKey",id:"seokey",level:3},{value:"Defined in",id:"defined-in-28",level:4},{value:"VIPImageLoader",id:"vipimageloader",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Defined in",id:"defined-in-29",level:4},{value:"convertUrl",id:"converturl",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Defined in",id:"defined-in-30",level:4},{value:"getPathName",id:"getpathname",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-20",level:4},{value:"Defined in",id:"defined-in-31",level:4},{value:"getSiteFromContext",id:"getsitefromcontext",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-21",level:4},{value:"Defined in",id:"defined-in-32",level:4},{value:"usePrepareFetch",id:"usepreparefetch",level:3},{value:"Type parameters",id:"type-parameters-16",level:4},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-22",level:4},{value:"Defined in",id:"defined-in-33",level:4},{value:"React Components",id:"react-components",level:2},{value:"HeadlessApp",id:"headlessapp",level:3},{value:"Usage",id:"usage-9",level:4},{value:"Parameters",id:"parameters-22",level:4},{value:"Returns",id:"returns-23",level:4},{value:"Defined in",id:"defined-in-34",level:4},{value:"ImageComponent",id:"imagecomponent",level:3},{value:"Usage",id:"usage-10",level:4},{value:"Parameters",id:"parameters-23",level:4},{value:"Returns",id:"returns-24",level:4},{value:"Defined in",id:"defined-in-35",level:4},{value:"LinkBlock",id:"linkblock",level:3},{value:"Usage",id:"usage-11",level:4},{value:"Parameters",id:"parameters-24",level:4},{value:"Returns",id:"returns-25",level:4},{value:"Defined in",id:"defined-in-36",level:4},{value:"TwitterBlock",id:"twitterblock",level:3},{value:"Usage",id:"usage-12",level:4},{value:"Parameters",id:"parameters-25",level:4},{value:"Returns",id:"returns-26",level:4},{value:"Defined in",id:"defined-in-37",level:4},{value:"Yoast",id:"yoast",level:3},{value:"Parameters",id:"parameters-26",level:4},{value:"Returns",id:"returns-27",level:4},{value:"Defined in",id:"defined-in-38",level:4}],s={toc:o};function k(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"namespaces"},"Namespaces"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/namespaces/headstartwp_next.config"},"config")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/namespaces/headstartwp_next.middlewares"},"middlewares"))),(0,r.kt)("h2",{id:"interfaces"},"Interfaces"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_next.FetchHookDataOptions"},"FetchHookDataOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_next.ImageProps"},"ImageProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_next.LinkBlockProps"},"LinkBlockProps"))),(0,r.kt)("h2",{id:"api-handlers"},"API handlers"),(0,r.kt)("h3",{id:"previewhandler"},"previewHandler"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"previewHandler"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"req"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"res"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"The PreviewHandler is responsible for handling preview requests."),(0,r.kt)("p",null,"Handling Previews requires the Headless WordPress Plugin."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Important"),": This function is meant to be used in a api route at ",(0,r.kt)("inlineCode",{parentName:"p"},"/pages/api/preview"),"."),(0,r.kt)("h4",{id:"usage"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"// pages/api/preview.js\nimport { previewHandler } from '@headstartwp/next';\n\nexport default async function handler(req, res) {\n return previewHandler(req, res);\n}\n")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"req")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"NextApiRequest")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The request object,")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"res")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"NextApiResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The response object.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewhandleroptions"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewHandlerOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The PreviewHandlerOptions ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewhandleroptions"},"PreviewHandlerOptions"))))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"A response object."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/handlers/previewHandler.ts#L120"},"packages/next/src/handlers/previewHandler.ts:120")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"revalidatehandler"},"revalidateHandler"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"revalidateHandler"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"req"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"res"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"The RevalidateHandler is responsible for handling revalidate requests."),(0,r.kt)("p",null,"Handling revalidate requires the Headless WordPress Plugin."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Important"),": This function is meant to be used in a api route e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"/pages/api/revalidate"),"."),(0,r.kt)("h4",{id:"usage-1"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"// pages/api/revalidate.js\nimport { revalidateHandler } from '@headstartwp/next';\n\nexport default async function handler(req, res) {\n return revalidateHandler(req, res);\n}\n")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"req")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"NextApiRequest")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The request object,")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"res")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"NextApiResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The response object.")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"A response object."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/handlers/revalidateHandler.ts#L30"},"packages/next/src/handlers/revalidateHandler.ts:30")),(0,r.kt)("h2",{id:"data-fetching-hooks"},"Data Fetching Hooks"),(0,r.kt)("h3",{id:"useappsettings"},"useAppSettings"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useAppSettings"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"useAppSettingsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useAppSettings hook"),(0,r.kt)("h4",{id:"usage-2"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"const { data, loading, error } = useAppSettings();\n\n// check loading and error states\n")),(0,r.kt)("h5",{id:"server-side-rendering-or-static-site-generation"},"Server-Side-Rendering or Static-Site-Generation"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"export async function getServerSideProps(context) {\n const useAppSettingsData = await fetchHookData(useAppSettings.fetcher(), context);\n return addHookData([useAppSettingsData], {});\n}\n")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Important"),": You most likely want to fetch app settings on every route so\nthat you can access global settings and menus in your pages & components"),(0,r.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"AppEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"AppEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"EndpointParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"EndpointParams"))))),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"useAppSettingsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/hooks/useAppSettings.ts#L33"},"packages/next/src/data/hooks/useAppSettings.ts:33")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useauthorarchive"},"useAuthorArchive"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useAuthorArchive"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"usePostsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useAuthorArchive hook. Returns a collection of post entities queried by author"),(0,r.kt)("p",null,"This hook must be used with a catch-all route ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js")," (e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/author/[...path].js"),")"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Important"),": Use a catch-all and not an optional catch-all route (",(0,r.kt)("inlineCode",{parentName:"p"},"[[...path]].js"),") as the author param in the url is required."),(0,r.kt)("p",null,"In order to automatically map URL params create a catch-all route named ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js"),".\nYou can create the catch-all at any level e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/author/[...path].js"),", etc."),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/author/[...path].js")," route for instance would yield a URL like this: ",(0,r.kt)("inlineCode",{parentName:"p"},"/author-name/page/2"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"/author-name/category/category-name/page/3"),", etc."),(0,r.kt)("p",null,"The following URL params are supported:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"Category (/author-name/category/category-name)"),(0,r.kt)("li",{parentName:"ul"},"Tag (/author-name/tag/tag-name)"),(0,r.kt)("li",{parentName:"ul"},"Author (/author/author-name)"),(0,r.kt)("li",{parentName:"ul"},"Pagination (/page/2)"),(0,r.kt)("li",{parentName:"ul"},"Custom Taxonomy (/author//taxonomy/term-name)")),(0,r.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostsArchiveParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostsArchiveParams"))))),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"usePostsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/hooks/useAuthorArchive.ts#L29"},"packages/next/src/data/hooks/useAuthorArchive.ts:29")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usemenu"},"useMenu"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useMenu"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"menuLocation"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"useMenuResponse")),(0,r.kt)("p",null,"The useMenu hooks. Returns a Menu object."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Important"),": This hook depends on ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#useappsettings"},"useAppSettings"),". If you want to enable SSR;SSG for\nthis hook you will need to fetch app settings on the server side."),(0,r.kt)("h4",{id:"usage-3"},"Usage"),(0,r.kt)("h3",{id:"basic-usage"},"Basic usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"export const Nav = () => {\n const { data, loading, error } = useMenu('primary-menu');\n\n // handle loading, error states\n\n return ;\n}\n")),(0,r.kt)("h5",{id:"re-fetching-client-side-on-focus-andor-mount"},"Re-fetching client-side on focus and/or mount"),(0,r.kt)("p",null,"If you are fetching app settings on the server, you can enable re-fetching on focus and/or mount\nto ensure menus are always up-to date even when using SSG/ISR."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"export const Nav = () => {\n const { data, loading, error } = useMenu('primary-menu', {\n revalidateOnFocus: true,\n revalidateOnMount: true,\n });\n\n // handle loading, error states\n\n return ;\n}\n")),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"menuLocation")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The slug of the menu location you want to fetch")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"AppEntity"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"SWR configuration options")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"useMenuResponse")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/hooks/useMenu.ts#L46"},"packages/next/src/data/hooks/useMenu.ts:46")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usepost"},"usePost"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"usePost"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"usePostResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The usePost hook. Returns a single post entity"),(0,r.kt)("p",null,"In order to automatically map URL params create a catch-all route named ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js"),".\nYou can create the catch-all at any level e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/[...path].js"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/blog/[...path].js"),", etc."),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/[...path].js")," route for instance would yield a URL like this: ",(0,r.kt)("inlineCode",{parentName:"p"},"/post-slug"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"/2020/01/01/post-slug"),", etc."),(0,r.kt)("h4",{id:"type-parameters-2"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostParams"))))),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"usePostResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/hooks/usePost.ts#L18"},"packages/next/src/data/hooks/usePost.ts:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usepostorposts"},"usePostOrPosts"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"usePostOrPosts"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"usePostOrPostResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The usePostOrPosts hook"),(0,r.kt)("h4",{id:"type-parameters-3"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostOrPostsParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostOrPostsParams"))))),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PostOrPostsFetchStrategyResult"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"usePostOrPostResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/hooks/usePostOrPosts.ts#L18"},"packages/next/src/data/hooks/usePostOrPosts.ts:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useposts"},"usePosts"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"usePosts"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"usePostsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The usePost hook. Returns a collection of post entities"),(0,r.kt)("p",null,"In order to automatically map URL params create a catch-all route named ",(0,r.kt)("inlineCode",{parentName:"p"},"[[...path]].js"),".\nYou can create the catch-all at any level e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/[[...path]].js"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/blog/[[...path]].js"),", etc."),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/blog/[[...path]].js")," route for instance would yield a URL like this: ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog/page/2"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog/category/category-name/page/3"),", etc."),(0,r.kt)("p",null,"The following URL params are supported:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"Category (/category/category-name)"),(0,r.kt)("li",{parentName:"ul"},"Tag (/tag/tag-name)"),(0,r.kt)("li",{parentName:"ul"},"Author (/author/author-name)"),(0,r.kt)("li",{parentName:"ul"},"Pagination (/page/2)"),(0,r.kt)("li",{parentName:"ul"},"Date (/YYYY/MM/DD)"),(0,r.kt)("li",{parentName:"ul"},"Custom Taxonomy (/taxonomy/term-name)")),(0,r.kt)("h4",{id:"handling-multiple-wordpress-routes-in-a-single-nextjs-route"},"Handling multiple WordPress routes in a single next.js route"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," hook is very flexible and can handle multiple WordPress routes in a single next.js route when using the optional-catch-all route (",(0,r.kt)("inlineCode",{parentName:"p"},"[[...path]].js"),").\nAlongside with the actual data, ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," also returns information about the current route so you can conditionally load different components."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"const params = { postType: 'post' };\nconst Posts = () => {\n const { data, pageType } = usePosts(params);\n\n if (pageType.isAuthorArchive) {\n return \n }\n\n if (pageType.isCategoryArchive) {\n return \n }\n\n if (pageType.isTaxonomyArchive && pageType.taxonomy === 'my-custom-taxonomy' ) {\n return \n }\n\n return (\n
\n
    \n {data.posts.map((post) => (\n
  • \n {post.title.rendered}\n
    • \n ))}\n
\n
\n );\n};\n")),(0,r.kt)("h4",{id:"type-parameters-4"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostsArchiveParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostsArchiveParams"))))),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"usePostsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/hooks/usePosts.ts#L62"},"packages/next/src/data/hooks/usePosts.ts:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usesearch"},"useSearch"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSearch"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"useSearchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useSearch hook. Returns a collection of search entities"),(0,r.kt)("p",null,"In order to automatically map URL params create a catch-all route named ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js"),".\nYou can create the catch-all at any level e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/search/[[...path]].js")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/search/[[...path]].js")," route for instance would yield a URL like this: ",(0,r.kt)("inlineCode",{parentName:"p"},"/search/[term]/page/[number]"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"/search/[term]")," etc"),(0,r.kt)("h4",{id:"type-parameters-5"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostsArchiveParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostsArchiveParams"))))),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"useSearchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/hooks/useSearch.ts#L18"},"packages/next/src/data/hooks/useSearch.ts:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usesearchnative"},"useSearchNative"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSearchNative"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"useSearchNativeResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useSearchNative hook. Returns a collection of search entities retrieved through the WP native search endpoint."),(0,r.kt)("p",null,"In order to automatically map URL params create a catch-all route named ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js"),".\nYou can create the catch-all at any level e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/search/[[...path]].js")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/search/[[...path]].js")," route for instance would yield a URL like this: ",(0,r.kt)("inlineCode",{parentName:"p"},"/search/[term]/page/[number]"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"/search/[term]")," etc"),(0,r.kt)("h4",{id:"type-parameters-6"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostSearchEntity")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"TermSearchEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostSearchEntity")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"TermSearchEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"SearchParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"SearchParams"))))),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"useSearchNativeResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/hooks/useSearchNative.ts#L18"},"packages/next/src/data/hooks/useSearchNative.ts:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useseo"},"useSeo"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSeo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"format"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("p",null,"The useSeo hook. Returns the current SEO object"),(0,r.kt)("h4",{id:"usage-4"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"const seo = useSeo();\n")),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"format")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},'"json"')),(0,r.kt)("td",{parentName:"tr",align:"left"},"how to return the seo object. Defaults to 'json'")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/hooks/useSeo.ts#L18"},"packages/next/src/data/hooks/useSeo.ts:18")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSeo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"format"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"format")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},'"html"'))))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/hooks/useSeo.ts#L19"},"packages/next/src/data/hooks/useSeo.ts:19")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSeo"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/hooks/useSeo.ts#L20"},"packages/next/src/data/hooks/useSeo.ts:20")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useterms"},"useTerms"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useTerms"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"useTermsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useTerms hook. Returns a collection of term entities"),(0,r.kt)("h4",{id:"usage-5"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"const { loading, data } = useTerms({ taxonomy: 'category', slug: 'cat-name' });\n")),(0,r.kt)("h4",{id:"type-parameters-7"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"TermEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"TermEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"TaxonomyArchiveParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"TaxonomyArchiveParams"))))),(0,r.kt)("h4",{id:"parameters-12"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"useTermsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/hooks/useTerms.ts#L19"},"packages/next/src/data/hooks/useTerms.ts:19")),(0,r.kt)("h2",{id:"nextjs-data-fetching-utilities"},"Next.js Data Fetching Utilities"),(0,r.kt)("h3",{id:"addhookdata"},"addHookData"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"addHookData"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"_hookStates"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"nextProps"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"addHookData")," function is responsible for collecting all of the results from the ",(0,r.kt)("inlineCode",{parentName:"p"},"fetchHookData")," function calls\nand prepares the shape of the data to match what the frameworks expects (such as setting initial values for SWR and collecting SEO data)."),(0,r.kt)("h4",{id:"usage-6"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"export async function getServerSideProps(context) {\n try {\n const usePostsHook = await fetchHookData(usePosts.fetcher(),context);\n const useAppSettingsHook = await fetchHookData(useAppSettings.fetcher(),context);\n return addHookData([usePostsHook, useAppSettingsHook], {});\n } catch (e) {\n return handleError(e, context);\n }\n}\n")),(0,r.kt)("h4",{id:"type-parameters-8"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"[key: string]"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),"; }")))),(0,r.kt)("h4",{id:"parameters-13"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"_hookStates")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#hookstate"},(0,r.kt)("inlineCode",{parentName:"a"},"HookState")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Entity")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Entity"),"[]",">",">","[]"),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"nextProps")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#nextjsprops"},(0,r.kt)("inlineCode",{parentName:"a"},"NextJSProps")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Any additional props to pass to Next.js page routes.")))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"notFound?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"fallback"),": {} ; ",(0,r.kt)("inlineCode",{parentName:"td"},"seo"),": { ",(0,r.kt)("inlineCode",{parentName:"td"},"yoast_head"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," = seo; ",(0,r.kt)("inlineCode",{parentName:"td"},"yoast_head_json"),": {} = seo","_","json } ; ",(0,r.kt)("inlineCode",{parentName:"td"},"themeJSON"),": {} }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props.fallback")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{}")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props.seo")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"yoast_head"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," = seo; ",(0,r.kt)("inlineCode",{parentName:"td"},"yoast_head_json"),": {} = seo","_","json }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props.seo.yoast_head")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props.seo.yoast_head_json")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{}")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props.themeJSON")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{}")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"redirect?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Redirect"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"revalidate?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/server/addHookData.ts#L59"},"packages/next/src/data/server/addHookData.ts:59")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"converttopath"},"convertToPath"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"convertToPath"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"args"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Creates a path from array of arguments"),(0,r.kt)("h4",{id:"parameters-14"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Array of catch-all arguments")))),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/convertToPath.ts#L8"},"packages/next/src/data/convertToPath.ts:8")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchhookdata"},"fetchHookData"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchHookData"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"R"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"fetchStrategy"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"ctx"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"additionalCacheObjects"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"data"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"R"),">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"isMainQuery"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }",">"),(0,r.kt)("p",null,"A function that implements data fetching on the server. This should be used in ",(0,r.kt)("inlineCode",{parentName:"p"},"getServerSideProps"),"\nor ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticProps"),"."),(0,r.kt)("p",null,"Data fetching will be performed by the specified strategy and URL params will be automatically extracted\nfrom `context"),(0,r.kt)("h4",{id:"usage-7"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"export async function getServerSideProps(context) {\n try {\n const usePostsHook = await fetchHookData(usePosts.fetcher(),context);\n\n return addHookData([usePostsHook], {});\n } catch (e) {\n return handleError(e, context);\n }\n}\n")),(0,r.kt)("p",null,"@param fetchStrategy The fetch strategy to use. Typically this is exposed by the hook e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts.fetcher()"),"\n@param ctx The Next.js context, either the one from ",(0,r.kt)("inlineCode",{parentName:"p"},"getServerSideProps")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticProps"),"\n@param options See {@link FetchHookDataOptions}"),(0,r.kt)("p",null,"@returns An object with a key of ",(0,r.kt)("inlineCode",{parentName:"p"},"data")," and a value of the fetched data."),(0,r.kt)("h4",{id:"type-parameters-9"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"unknown"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"EndpointParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"EndpointParams"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"R")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))))),(0,r.kt)("h4",{id:"parameters-15"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetchStrategy")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AbstractFetchStrategy"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"R"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ctx")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"GetServerSidePropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),", ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),">"," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"GetStaticPropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),", ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_next.FetchHookDataOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookDataOptions")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">")))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"additionalCacheObjects"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"data"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"R"),">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"isMainQuery"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }",">"),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/server/fetchHookData.ts#L81"},"packages/next/src/data/server/fetchHookData.ts:81")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"handleerror"},"handleError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"handleError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"ctx"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"rootRoute?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"GetServerSidePropsResult"),"<{}",">",">"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"handleError")," function is responsible for handling errors that occur during\ndata fetching in ",(0,r.kt)("inlineCode",{parentName:"p"},"getServerSideProps")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticProps"),"."),(0,r.kt)("p",null,"It also handles redirects if ",(0,r.kt)("inlineCode",{parentName:"p"},"redirectStrategy")," is set to ",(0,r.kt)("inlineCode",{parentName:"p"},"404")," in ",(0,r.kt)("inlineCode",{parentName:"p"},"headless.config.js")),(0,r.kt)("p",null,"If ",(0,r.kt)("inlineCode",{parentName:"p"},"error")," is of type NotFoundError it will redirect to the 404 page. Otherwise it will\nreturn a server error (500) page"),(0,r.kt)("h4",{id:"usage-8"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"export async function getServerSideProps(context) {\n try {\n const usePostsHook = await fetchHookData(usePosts.fetcher(),context);\n return addHookData([usePostsHook], {});\n } catch (e) {\n return handleError(e, context);\n }\n}\n")),(0,r.kt)("h4",{id:"parameters-16"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The error object")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ctx")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#headlessgetserversidepropscontext"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessGetServerSidePropsContext")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"),">"," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#headlessgetstaticpropspropscontext"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessGetStaticPropsPropsContext")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The Next.js context")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"rootRoute")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The root route (deprecated/unnecessary). This needs to be revisited")))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"GetServerSidePropsResult"),"<{}",">",">"),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/server/handleError.ts#L62"},"packages/next/src/data/server/handleError.ts:62")),(0,r.kt)("h2",{id:"other"},"Other"),(0,r.kt)("h3",{id:"headlessappprops"},"HeadlessAppProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HeadlessAppProps"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The props supported by ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#headlessapp"},"HeadlessApp"),"."),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"children?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ReactNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"handleYoast?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If true, will automatically load yoast seo metadata into the head ",(0,r.kt)("strong",{parentName:"td"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))," true")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pageProps")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The page props from next.js. It should contain ",(0,r.kt)("inlineCode",{parentName:"td"},"fallback"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"themeJson")," and other props. Those props are added when using ",(0,r.kt)("inlineCode",{parentName:"td"},"fetchHookData")," and ",(0,r.kt)("inlineCode",{parentName:"td"},"addHookData")," ",(0,r.kt)("strong",{parentName:"td"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))," - ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#fetchhookdata"},"fetchHookData")," - ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#addhookdata"},"addHookData"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"settings")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SettingsContextProps")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Supported settings by the framework. Such as custom image component, custom link component etc. ",(0,r.kt)("strong",{parentName:"td"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))," SettingsContextProps")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"swrConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"DataFetchingProviderProps"),"[",(0,r.kt)("inlineCode",{parentName:"td"},'"swrConfig"'),"]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Pass any configuration to the SWR library. Globally. These settings can be overridden at the hook level.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"useYoastHtml?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If true, will make the Yoast component use the ",(0,r.kt)("inlineCode",{parentName:"td"},"yoast_head")," raw html to populate meta tags instead of ",(0,r.kt)("inlineCode",{parentName:"td"},"yoast_head_json"),". ",(0,r.kt)("inlineCode",{parentName:"td"},"yoast_head")," is the default and preferable option.")))),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/components/HeadlessApp.tsx#L18"},"packages/next/src/components/HeadlessApp.tsx:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"headlessgetserversideprops"},"HeadlessGetServerSideProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HeadlessGetServerSideProps"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"GetServerSideProps"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),">"),(0,r.kt)("h4",{id:"type-parameters-10"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Object")," = { ",(0,r.kt)("inlineCode",{parentName:"td"},"[key: string]"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),"; }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Q")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"))))),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/types.ts#L16"},"packages/next/src/data/types.ts:16")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"headlessgetserversidepropscontext"},"HeadlessGetServerSidePropsContext"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HeadlessGetServerSidePropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"GetServerSidePropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),">"),(0,r.kt)("h4",{id:"type-parameters-11"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Q")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"))))),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/types.ts#L10"},"packages/next/src/data/types.ts:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"headlessgetstaticprops"},"HeadlessGetStaticProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HeadlessGetStaticProps"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"GetStaticProps"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),">"),(0,r.kt)("h4",{id:"type-parameters-12"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Object")," = { ",(0,r.kt)("inlineCode",{parentName:"td"},"[key: string]"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),"; }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Q")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"))))),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/types.ts#L21"},"packages/next/src/data/types.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"headlessgetstaticpropspropscontext"},"HeadlessGetStaticPropsPropsContext"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HeadlessGetStaticPropsPropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"GetStaticPropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),">"),(0,r.kt)("h4",{id:"type-parameters-13"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Q")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"))))),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/types.ts#L13"},"packages/next/src/data/types.ts:13")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hookstate"},"HookState"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HookState"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-parameters-14"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))))),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"additionalCacheObjects?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#hookstate"},(0,r.kt)("inlineCode",{parentName:"a"},"HookState")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">","[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isMainQuery")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/server/addHookData.ts#L10"},"packages/next/src/data/server/addHookData.ts:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"nextjsprops"},"NextJSProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"NextJSProps"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-parameters-15"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P"))))),(0,r.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"notFound?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"redirect?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Redirect"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"revalidate?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/server/addHookData.ts#L17"},"packages/next/src/data/server/addHookData.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"previewdata"},"PreviewData"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"PreviewData"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The shape of the preview data that's stored in the preview data cookie"),(0,r.kt)("h4",{id:"index-signature"},"Index signature"),(0,r.kt)("p",null,"\u25aa ","[k: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"authToken")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The auth token that should be used to fetch the data")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the resource")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"postType")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The post type")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"revision")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Whether the preview data is on a revision")))),(0,r.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/handlers/types.ts#L4"},"packages/next/src/handlers/types.ts:4")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"previewhandleroptions"},"PreviewHandlerOptions"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"PreviewHandlerOptions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The options supported by ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#previewhandler"},"previewHandler")),(0,r.kt)("h4",{id:"type-declaration-4"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"getRedirectPath?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"defaultRedirectPath"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"post"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"postTypeDef"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"CustomPostType"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onRedirect?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"req"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"NextApiRequest"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"res"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"NextApiResponse"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"previewData"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),", ",(0,r.kt)("inlineCode",{parentName:"td"},"defaultRedirect?"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewhandleroptions"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewHandlerOptions")),"[",(0,r.kt)("inlineCode",{parentName:"td"},'"onRedirect"'),"]",", ",(0,r.kt)("inlineCode",{parentName:"td"},"redirectpath?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"preparePreviewData?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"req"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"NextApiRequest"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"res"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"NextApiResponse"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"post"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"previewData"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),") => ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")))))),(0,r.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/handlers/previewHandler.ts#L11"},"packages/next/src/handlers/previewHandler.ts:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"vipcustomimageloader"},"VIPCustomImageLoader"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"VIPCustomImageLoader"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ImageLoaderProps")," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"aspectRatio?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }"),(0,r.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/components/ImageComponent.tsx#L30"},"packages/next/src/components/ImageComponent.tsx:30")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"seokey"},"seoKey"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"seoKey"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"@seo"')),(0,r.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/hooks/useSeo.ts#L3"},"packages/next/src/data/hooks/useSeo.ts:3")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"vipimageloader"},"VIPImageLoader"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"VIPImageLoader"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Custom Image loader for WordPress VIP leveraging Photon's API. This can't be made\na global loader because of the local loader used on the custom image component."),(0,r.kt)("h4",{id:"parameters-17"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#vipcustomimageloader"},(0,r.kt)("inlineCode",{parentName:"a"},"VIPCustomImageLoader"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The loader props")))),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/components/ImageComponent.tsx#L42"},"packages/next/src/components/ImageComponent.tsx:42")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"converturl"},"convertUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"convertUrl"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"hostUrl"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"parameters-18"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hostUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-19"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/components/Yoast.tsx#L15"},"packages/next/src/components/Yoast.tsx:15")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getpathname"},"getPathName"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getPathName"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"resolvedUrl"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Extracts the path name out of the Next.js resolvedUrl"),(0,r.kt)("h4",{id:"parameters-19"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"resolvedUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The full resolved URL")))),(0,r.kt)("h4",{id:"returns-20"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/server/handleError.ts#L23"},"packages/next/src/data/server/handleError.ts:23")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsitefromcontext"},"getSiteFromContext"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSiteFromContext"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"ctx"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"HeadlessConfig")," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"p"},"customPostTypes"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"CustomPostTypes")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"customTaxonomies"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"CustomTaxonomies")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"debug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"p"},"devMode?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"redirects?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"requests?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"hostUrl"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"integrations"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Integrations")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"preview"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"PreviewConfig")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"redirectStrategy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"RedirectStrategy")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"sites"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"HeadlessConfig"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"useWordPressPlugin"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," }"),(0,r.kt)("p",null,"Get site using context"),(0,r.kt)("h4",{id:"parameters-20"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ctx")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"GetServerSidePropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"PreviewData"),">"," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"GetStaticPropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"PreviewData"),">")))),(0,r.kt)("h4",{id:"returns-21"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"HeadlessConfig")," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"p"},"customPostTypes"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"CustomPostTypes")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"customTaxonomies"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"CustomTaxonomies")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"debug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"p"},"devMode?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"redirects?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"requests?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"hostUrl"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"integrations"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Integrations")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"preview"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"PreviewConfig")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"redirectStrategy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"RedirectStrategy")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"sites"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"HeadlessConfig"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"useWordPressPlugin"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," }"),(0,r.kt)("p",null,"HeadlessConfig"),(0,r.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/server/getSiteFromContext.ts#L10"},"packages/next/src/data/server/getSiteFromContext.ts:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usepreparefetch"},"usePrepareFetch"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"usePrepareFetch"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"_params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Prepares params and options for useFetch hooks"),(0,r.kt)("h4",{id:"type-parameters-16"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Entity")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Entity"),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"EndpointParams"))))),(0,r.kt)("h4",{id:"parameters-21"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"_params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The fetch params")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The fetch options")))),(0,r.kt)("h4",{id:"returns-22"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/hooks/usePrepareFetch.ts#L13"},"packages/next/src/data/hooks/usePrepareFetch.ts:13")),(0,r.kt)("h2",{id:"react-components"},"React Components"),(0,r.kt)("h3",{id:"headlessapp"},"HeadlessApp"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"HeadlessApp"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The HeadlessApp component is the top level component for the Headless framework."),(0,r.kt)("p",null,"Should be used in ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/_app.js")),(0,r.kt)("h4",{id:"usage-9"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},'import { HeadlessApp } from "@headstartwp/next";\n\nconst MyApp = ({ Component, pageProps }) => {\n const { fallback = {}, themeJson = {}, ...props } = pageProps;\n\n return (\n \n \n \n \n \n );\n};\n\nexport default MyApp;\n')),(0,r.kt)("h4",{id:"parameters-22"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#headlessappprops"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessAppProps"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component props. See ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#headlessappprops"},"HeadlessAppProps"))))),(0,r.kt)("h4",{id:"returns-23"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/components/HeadlessApp.tsx#L96"},"packages/next/src/components/HeadlessApp.tsx:96")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"imagecomponent"},"ImageComponent"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ImageComponent"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"An implementation of the ImageBlock (core/image)."),(0,r.kt)("p",null,"If ",(0,r.kt)("inlineCode",{parentName:"p"},"width"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"height")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"src")," are not provided, this component will not be used."),(0,r.kt)("h4",{id:"usage-10"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},'import { BlocksRenderer, ImageBlock } from "@headstartwp/core/react";\nimport { ImageComponent } from "@headstartwp/next";\n\n\n \n\n')),(0,r.kt)("h4",{id:"parameters-23"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_next.ImageProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ImageProps"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"ImageBlockProps")))),(0,r.kt)("h4",{id:"returns-24"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/components/ImageComponent.tsx#L98"},"packages/next/src/components/ImageComponent.tsx:98")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"linkblock"},"LinkBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"LinkBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The Link Block converts a anchor tag node into a next/link component if it's an internal link"),(0,r.kt)("h4",{id:"usage-11"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},'import { BlocksRenderer } from "@headstartwp/core/react";\nimport { LinkBlock } from "@headstartwp/next";\n\n\n \n\n')),(0,r.kt)("h4",{id:"parameters-24"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Omit"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"IBlock"),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_next.LinkBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"LinkBlockProps")),">",", ",(0,r.kt)("inlineCode",{parentName:"td"},'"component"'),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Link Block Props")))),(0,r.kt)("h4",{id:"returns-25"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The next/link component"),(0,r.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/blocks/LinkBlock.tsx#L33"},"packages/next/src/blocks/LinkBlock.tsx:33")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"twitterblock"},"TwitterBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"TwitterBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"Renders a twitter embed"),(0,r.kt)("h4",{id:"usage-12"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},'import { BlocksRenderer } from "@headstartwp/core/react";\nimport { TwitterBlock } from "@headstartwp/next";\n\n\n \n\n')),(0,r.kt)("h4",{id:"parameters-25"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Omit"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"IBlock"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"IBlockAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"td"},'"component"'),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Link Block Props")))),(0,r.kt)("h4",{id:"returns-26"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/blocks/TwitterBlock.tsx#L25"},"packages/next/src/blocks/TwitterBlock.tsx:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast"},"Yoast"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"Yoast"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The Yoast component renders the Yoast SEO meta tags.\nThis component is automatically rendered by ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#headlessapp"},"HeadlessApp")," so you don't have to manually render it."),(0,r.kt)("h4",{id:"parameters-26"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Props")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component props. Expects a single ",(0,r.kt)("inlineCode",{parentName:"td"},"seo")," prop")))),(0,r.kt)("h4",{id:"returns-27"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/components/Yoast.tsx#L63"},"packages/next/src/components/Yoast.tsx:63")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/44b9bd65.995c8cde.js b/assets/js/44b9bd65.995c8cde.js new file mode 100644 index 000000000..25642f668 --- /dev/null +++ b/assets/js/44b9bd65.995c8cde.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3126],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var d=n.createContext({}),o=function(e){var t=n.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},s=function(e){var t=o(e.components);return n.createElement(d.Provider,{value:t},e.children)},k="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},N=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),k=o(a),N=r,h=k["".concat(d,".").concat(N)]||k[N]||m[N]||i;return a?n.createElement(h,p(p({ref:t},s),{},{components:a})):n.createElement(h,p({ref:t},s))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,p=new Array(i);p[0]=N;var l={};for(var d in t)hasOwnProperty.call(t,d)&&(l[d]=t[d]);l.originalType=e,l[k]="string"==typeof e?e:r,p[1]=l;for(var o=2;o{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>p,default:()=>k,frontMatter:()=>i,metadata:()=>l,toc:()=>o});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_next",title:"Module: @headstartwp/next",sidebar_label:"@headstartwp/next",sidebar_position:0,custom_edit_url:null},p=void 0,l={unversionedId:"modules/headstartwp_next",id:"modules/headstartwp_next",title:"Module: @headstartwp/next",description:"Namespaces",source:"@site/docs/modules/headstartwp_next.md",sourceDirName:"modules",slug:"/modules/headstartwp_next",permalink:"/docs/api/modules/headstartwp_next",draft:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"headstartwp_next",title:"Module: @headstartwp/next",sidebar_label:"@headstartwp/next",sidebar_position:0,custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core",permalink:"/docs/api/modules/headstartwp_core"},next:{title:"@headstartwp/core.react",permalink:"/docs/api/namespaces/headstartwp_core.react"}},d={},o=[{value:"Namespaces",id:"namespaces",level:2},{value:"Interfaces",id:"interfaces",level:2},{value:"API handlers",id:"api-handlers",level:2},{value:"previewHandler",id:"previewhandler",level:3},{value:"Usage",id:"usage",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"revalidateHandler",id:"revalidatehandler",level:3},{value:"Usage",id:"usage-1",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"Data Fetching Hooks",id:"data-fetching-hooks",level:2},{value:"useAppSettings",id:"useappsettings",level:3},{value:"Usage",id:"usage-2",level:4},{value:"Server-Side-Rendering or Static-Site-Generation",id:"server-side-rendering-or-static-site-generation",level:5},{value:"Type parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"useAuthorArchive",id:"useauthorarchive",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"useMenu",id:"usemenu",level:3},{value:"Usage",id:"usage-3",level:4},{value:"Basic usage",id:"basic-usage",level:3},{value:"Re-fetching client-side on focus and/or mount",id:"re-fetching-client-side-on-focus-andor-mount",level:5},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"usePost",id:"usepost",level:3},{value:"Type parameters",id:"type-parameters-2",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"usePostOrPosts",id:"usepostorposts",level:3},{value:"Type parameters",id:"type-parameters-3",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"usePosts",id:"useposts",level:3},{value:"Handling multiple WordPress routes in a single next.js route",id:"handling-multiple-wordpress-routes-in-a-single-nextjs-route",level:4},{value:"Type parameters",id:"type-parameters-4",level:4},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"useSearch",id:"usesearch",level:3},{value:"Type parameters",id:"type-parameters-5",level:4},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"useSearchNative",id:"usesearchnative",level:3},{value:"Type parameters",id:"type-parameters-6",level:4},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"useSeo",id:"useseo",level:3},{value:"Usage",id:"usage-4",level:4},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"useTerms",id:"useterms",level:3},{value:"Usage",id:"usage-5",level:4},{value:"Type parameters",id:"type-parameters-7",level:4},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"Next.js Data Fetching Utilities",id:"nextjs-data-fetching-utilities",level:2},{value:"addHookData",id:"addhookdata",level:3},{value:"Usage",id:"usage-6",level:4},{value:"Type parameters",id:"type-parameters-8",level:4},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"convertToPath",id:"converttopath",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"fetchHookData",id:"fetchhookdata",level:3},{value:"Usage",id:"usage-7",level:4},{value:"Type parameters",id:"type-parameters-9",level:4},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"handleError",id:"handleerror",level:3},{value:"Usage",id:"usage-8",level:4},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"Other",id:"other",level:2},{value:"HeadlessAppProps",id:"headlessappprops",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"HeadlessGetServerSideProps",id:"headlessgetserversideprops",level:3},{value:"Type parameters",id:"type-parameters-10",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"HeadlessGetServerSidePropsContext",id:"headlessgetserversidepropscontext",level:3},{value:"Type parameters",id:"type-parameters-11",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"HeadlessGetStaticProps",id:"headlessgetstaticprops",level:3},{value:"Type parameters",id:"type-parameters-12",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"HeadlessGetStaticPropsPropsContext",id:"headlessgetstaticpropspropscontext",level:3},{value:"Type parameters",id:"type-parameters-13",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"HookState",id:"hookstate",level:3},{value:"Type parameters",id:"type-parameters-14",level:4},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"NextJSProps",id:"nextjsprops",level:3},{value:"Type parameters",id:"type-parameters-15",level:4},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"PreviewData",id:"previewdata",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"PreviewHandlerOptions",id:"previewhandleroptions",level:3},{value:"Type declaration",id:"type-declaration-4",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"VIPCustomImageLoader",id:"vipcustomimageloader",level:3},{value:"Defined in",id:"defined-in-27",level:4},{value:"seoKey",id:"seokey",level:3},{value:"Defined in",id:"defined-in-28",level:4},{value:"VIPImageLoader",id:"vipimageloader",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Defined in",id:"defined-in-29",level:4},{value:"convertUrl",id:"converturl",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Defined in",id:"defined-in-30",level:4},{value:"getPathName",id:"getpathname",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-20",level:4},{value:"Defined in",id:"defined-in-31",level:4},{value:"getSiteFromContext",id:"getsitefromcontext",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-21",level:4},{value:"Defined in",id:"defined-in-32",level:4},{value:"prepareFetchHookData",id:"preparefetchhookdata",level:3},{value:"Type parameters",id:"type-parameters-16",level:4},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-22",level:4},{value:"Defined in",id:"defined-in-33",level:4},{value:"usePrepareFetch",id:"usepreparefetch",level:3},{value:"Type parameters",id:"type-parameters-17",level:4},{value:"Parameters",id:"parameters-22",level:4},{value:"Returns",id:"returns-23",level:4},{value:"Defined in",id:"defined-in-34",level:4},{value:"React Components",id:"react-components",level:2},{value:"HeadlessApp",id:"headlessapp",level:3},{value:"Usage",id:"usage-9",level:4},{value:"Parameters",id:"parameters-23",level:4},{value:"Returns",id:"returns-24",level:4},{value:"Defined in",id:"defined-in-35",level:4},{value:"ImageComponent",id:"imagecomponent",level:3},{value:"Usage",id:"usage-10",level:4},{value:"Parameters",id:"parameters-24",level:4},{value:"Returns",id:"returns-25",level:4},{value:"Defined in",id:"defined-in-36",level:4},{value:"LinkBlock",id:"linkblock",level:3},{value:"Usage",id:"usage-11",level:4},{value:"Parameters",id:"parameters-25",level:4},{value:"Returns",id:"returns-26",level:4},{value:"Defined in",id:"defined-in-37",level:4},{value:"TwitterBlock",id:"twitterblock",level:3},{value:"Usage",id:"usage-12",level:4},{value:"Parameters",id:"parameters-26",level:4},{value:"Returns",id:"returns-27",level:4},{value:"Defined in",id:"defined-in-38",level:4},{value:"Yoast",id:"yoast",level:3},{value:"Parameters",id:"parameters-27",level:4},{value:"Returns",id:"returns-28",level:4},{value:"Defined in",id:"defined-in-39",level:4}],s={toc:o};function k(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"namespaces"},"Namespaces"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/namespaces/headstartwp_next.config"},"config")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/namespaces/headstartwp_next.middlewares"},"middlewares"))),(0,r.kt)("h2",{id:"interfaces"},"Interfaces"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_next.FetchHookDataOptions"},"FetchHookDataOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_next.ImageProps"},"ImageProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_next.LinkBlockProps"},"LinkBlockProps"))),(0,r.kt)("h2",{id:"api-handlers"},"API handlers"),(0,r.kt)("h3",{id:"previewhandler"},"previewHandler"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"previewHandler"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"req"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"res"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"The PreviewHandler is responsible for handling preview requests."),(0,r.kt)("p",null,"Handling Previews requires the Headless WordPress Plugin."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Important"),": This function is meant to be used in a api route at ",(0,r.kt)("inlineCode",{parentName:"p"},"/pages/api/preview"),"."),(0,r.kt)("h4",{id:"usage"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"// pages/api/preview.js\nimport { previewHandler } from '@headstartwp/next';\n\nexport default async function handler(req, res) {\n return previewHandler(req, res);\n}\n")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"req")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"NextApiRequest")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The request object,")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"res")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"NextApiResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The response object.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewhandleroptions"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewHandlerOptions"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The PreviewHandlerOptions ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewhandleroptions"},"PreviewHandlerOptions"))))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"A response object."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/handlers/previewHandler.ts#L120"},"packages/next/src/handlers/previewHandler.ts:120")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"revalidatehandler"},"revalidateHandler"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"revalidateHandler"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"req"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"res"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"The RevalidateHandler is responsible for handling revalidate requests."),(0,r.kt)("p",null,"Handling revalidate requires the Headless WordPress Plugin."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Important"),": This function is meant to be used in a api route e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"/pages/api/revalidate"),"."),(0,r.kt)("h4",{id:"usage-1"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"// pages/api/revalidate.js\nimport { revalidateHandler } from '@headstartwp/next';\n\nexport default async function handler(req, res) {\n return revalidateHandler(req, res);\n}\n")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"req")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"NextApiRequest")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The request object,")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"res")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"NextApiResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The response object.")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"void"),">"),(0,r.kt)("p",null,"A response object."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/handlers/revalidateHandler.ts#L30"},"packages/next/src/handlers/revalidateHandler.ts:30")),(0,r.kt)("h2",{id:"data-fetching-hooks"},"Data Fetching Hooks"),(0,r.kt)("h3",{id:"useappsettings"},"useAppSettings"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useAppSettings"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"useAppSettingsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useAppSettings hook"),(0,r.kt)("h4",{id:"usage-2"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"const { data, loading, error } = useAppSettings();\n\n// check loading and error states\n")),(0,r.kt)("h5",{id:"server-side-rendering-or-static-site-generation"},"Server-Side-Rendering or Static-Site-Generation"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"export async function getServerSideProps(context) {\n const useAppSettingsData = await fetchHookData(useAppSettings.fetcher(), context);\n return addHookData([useAppSettingsData], {});\n}\n")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Important"),": You most likely want to fetch app settings on every route so\nthat you can access global settings and menus in your pages & components"),(0,r.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"AppEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"AppEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"EndpointParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"EndpointParams"))))),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"useAppSettingsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/hooks/useAppSettings.ts#L33"},"packages/next/src/data/hooks/useAppSettings.ts:33")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useauthorarchive"},"useAuthorArchive"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useAuthorArchive"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"usePostsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useAuthorArchive hook. Returns a collection of post entities queried by author"),(0,r.kt)("p",null,"This hook must be used with a catch-all route ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js")," (e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/author/[...path].js"),")"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Important"),": Use a catch-all and not an optional catch-all route (",(0,r.kt)("inlineCode",{parentName:"p"},"[[...path]].js"),") as the author param in the url is required."),(0,r.kt)("p",null,"In order to automatically map URL params create a catch-all route named ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js"),".\nYou can create the catch-all at any level e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/author/[...path].js"),", etc."),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/author/[...path].js")," route for instance would yield a URL like this: ",(0,r.kt)("inlineCode",{parentName:"p"},"/author-name/page/2"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"/author-name/category/category-name/page/3"),", etc."),(0,r.kt)("p",null,"The following URL params are supported:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"Category (/author-name/category/category-name)"),(0,r.kt)("li",{parentName:"ul"},"Tag (/author-name/tag/tag-name)"),(0,r.kt)("li",{parentName:"ul"},"Author (/author/author-name)"),(0,r.kt)("li",{parentName:"ul"},"Pagination (/page/2)"),(0,r.kt)("li",{parentName:"ul"},"Custom Taxonomy (/author//taxonomy/term-name)")),(0,r.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostsArchiveParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostsArchiveParams"))))),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"usePostsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/hooks/useAuthorArchive.ts#L29"},"packages/next/src/data/hooks/useAuthorArchive.ts:29")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usemenu"},"useMenu"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useMenu"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"menuLocation"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"useMenuResponse")),(0,r.kt)("p",null,"The useMenu hooks. Returns a Menu object."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Important"),": This hook depends on ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#useappsettings"},"useAppSettings"),". If you want to enable SSR;SSG for\nthis hook you will need to fetch app settings on the server side."),(0,r.kt)("h4",{id:"usage-3"},"Usage"),(0,r.kt)("h3",{id:"basic-usage"},"Basic usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"export const Nav = () => {\n const { data, loading, error } = useMenu('primary-menu');\n\n // handle loading, error states\n\n return ;\n}\n")),(0,r.kt)("h5",{id:"re-fetching-client-side-on-focus-andor-mount"},"Re-fetching client-side on focus and/or mount"),(0,r.kt)("p",null,"If you are fetching app settings on the server, you can enable re-fetching on focus and/or mount\nto ensure menus are always up-to date even when using SSG/ISR."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"export const Nav = () => {\n const { data, loading, error } = useMenu('primary-menu', {\n revalidateOnFocus: true,\n revalidateOnMount: true,\n });\n\n // handle loading, error states\n\n return ;\n}\n")),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"menuLocation")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The slug of the menu location you want to fetch")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"AppEntity"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"SWR configuration options")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"useMenuResponse")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/hooks/useMenu.ts#L46"},"packages/next/src/data/hooks/useMenu.ts:46")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usepost"},"usePost"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"usePost"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"usePostResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The usePost hook. Returns a single post entity"),(0,r.kt)("p",null,"In order to automatically map URL params create a catch-all route named ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js"),".\nYou can create the catch-all at any level e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/[...path].js"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/blog/[...path].js"),", etc."),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/[...path].js")," route for instance would yield a URL like this: ",(0,r.kt)("inlineCode",{parentName:"p"},"/post-slug"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"/2020/01/01/post-slug"),", etc."),(0,r.kt)("h4",{id:"type-parameters-2"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostParams"))))),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"usePostResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/hooks/usePost.ts#L18"},"packages/next/src/data/hooks/usePost.ts:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usepostorposts"},"usePostOrPosts"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"usePostOrPosts"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"usePostOrPostResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The usePostOrPosts hook"),(0,r.kt)("h4",{id:"type-parameters-3"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostOrPostsParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostOrPostsParams"))))),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PostOrPostsFetchStrategyResult"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"usePostOrPostResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/hooks/usePostOrPosts.ts#L18"},"packages/next/src/data/hooks/usePostOrPosts.ts:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useposts"},"usePosts"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"usePosts"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"usePostsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The usePost hook. Returns a collection of post entities"),(0,r.kt)("p",null,"In order to automatically map URL params create a catch-all route named ",(0,r.kt)("inlineCode",{parentName:"p"},"[[...path]].js"),".\nYou can create the catch-all at any level e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/[[...path]].js"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/blog/[[...path]].js"),", etc."),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/blog/[[...path]].js")," route for instance would yield a URL like this: ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog/page/2"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog/category/category-name/page/3"),", etc."),(0,r.kt)("p",null,"The following URL params are supported:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"Category (/category/category-name)"),(0,r.kt)("li",{parentName:"ul"},"Tag (/tag/tag-name)"),(0,r.kt)("li",{parentName:"ul"},"Author (/author/author-name)"),(0,r.kt)("li",{parentName:"ul"},"Pagination (/page/2)"),(0,r.kt)("li",{parentName:"ul"},"Date (/YYYY/MM/DD)"),(0,r.kt)("li",{parentName:"ul"},"Custom Taxonomy (/taxonomy/term-name)")),(0,r.kt)("h4",{id:"handling-multiple-wordpress-routes-in-a-single-nextjs-route"},"Handling multiple WordPress routes in a single next.js route"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," hook is very flexible and can handle multiple WordPress routes in a single next.js route when using the optional-catch-all route (",(0,r.kt)("inlineCode",{parentName:"p"},"[[...path]].js"),").\nAlongside with the actual data, ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," also returns information about the current route so you can conditionally load different components."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"const params = { postType: 'post' };\nconst Posts = () => {\n const { data, pageType } = usePosts(params);\n\n if (pageType.isAuthorArchive) {\n return \n }\n\n if (pageType.isCategoryArchive) {\n return \n }\n\n if (pageType.isTaxonomyArchive && pageType.taxonomy === 'my-custom-taxonomy' ) {\n return \n }\n\n return (\n
\n
    \n {data.posts.map((post) => (\n
  • \n {post.title.rendered}\n
    • \n ))}\n
\n
\n );\n};\n")),(0,r.kt)("h4",{id:"type-parameters-4"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostsArchiveParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostsArchiveParams"))))),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"usePostsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/hooks/usePosts.ts#L62"},"packages/next/src/data/hooks/usePosts.ts:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usesearch"},"useSearch"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSearch"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"useSearchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useSearch hook. Returns a collection of search entities"),(0,r.kt)("p",null,"In order to automatically map URL params create a catch-all route named ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js"),".\nYou can create the catch-all at any level e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/search/[[...path]].js")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/search/[[...path]].js")," route for instance would yield a URL like this: ",(0,r.kt)("inlineCode",{parentName:"p"},"/search/[term]/page/[number]"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"/search/[term]")," etc"),(0,r.kt)("h4",{id:"type-parameters-5"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostsArchiveParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostsArchiveParams"))))),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"useSearchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/hooks/useSearch.ts#L18"},"packages/next/src/data/hooks/useSearch.ts:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usesearchnative"},"useSearchNative"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSearchNative"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"useSearchNativeResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useSearchNative hook. Returns a collection of search entities retrieved through the WP native search endpoint."),(0,r.kt)("p",null,"In order to automatically map URL params create a catch-all route named ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js"),".\nYou can create the catch-all at any level e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/search/[[...path]].js")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/search/[[...path]].js")," route for instance would yield a URL like this: ",(0,r.kt)("inlineCode",{parentName:"p"},"/search/[term]/page/[number]"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"/search/[term]")," etc"),(0,r.kt)("h4",{id:"type-parameters-6"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"PostSearchEntity")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"TermSearchEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"PostSearchEntity")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"TermSearchEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"SearchParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"SearchParams"))))),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"useSearchNativeResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/hooks/useSearchNative.ts#L18"},"packages/next/src/data/hooks/useSearchNative.ts:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useseo"},"useSeo"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSeo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"format"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("p",null,"The useSeo hook. Returns the current SEO object"),(0,r.kt)("h4",{id:"usage-4"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"const seo = useSeo();\n")),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"format")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},'"json"')),(0,r.kt)("td",{parentName:"tr",align:"left"},"how to return the seo object. Defaults to 'json'")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/hooks/useSeo.ts#L18"},"packages/next/src/data/hooks/useSeo.ts:18")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSeo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"format"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"format")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},'"html"'))))),(0,r.kt)("h4",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/hooks/useSeo.ts#L19"},"packages/next/src/data/hooks/useSeo.ts:19")),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSeo"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"null")),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/hooks/useSeo.ts#L20"},"packages/next/src/data/hooks/useSeo.ts:20")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useterms"},"useTerms"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useTerms"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"useTermsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useTerms hook. Returns a collection of term entities"),(0,r.kt)("h4",{id:"usage-5"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"const { loading, data } = useTerms({ taxonomy: 'category', slug: 'cat-name' });\n")),(0,r.kt)("h4",{id:"type-parameters-7"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"TermEntity")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"TermEntity"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"TaxonomyArchiveParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"TaxonomyArchiveParams"))))),(0,r.kt)("h4",{id:"parameters-12"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The parameters accepted by the hook")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Options for the SWR configuration")))),(0,r.kt)("h4",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"useTermsResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/hooks/useTerms.ts#L19"},"packages/next/src/data/hooks/useTerms.ts:19")),(0,r.kt)("h2",{id:"nextjs-data-fetching-utilities"},"Next.js Data Fetching Utilities"),(0,r.kt)("h3",{id:"addhookdata"},"addHookData"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"addHookData"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"_hookStates"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"nextProps"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"addHookData")," function is responsible for collecting all of the results from the ",(0,r.kt)("inlineCode",{parentName:"p"},"fetchHookData")," function calls\nand prepares the shape of the data to match what the frameworks expects (such as setting initial values for SWR and collecting SEO data)."),(0,r.kt)("h4",{id:"usage-6"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"export async function getServerSideProps(context) {\n try {\n const usePostsHook = await fetchHookData(usePosts.fetcher(),context);\n const useAppSettingsHook = await fetchHookData(useAppSettings.fetcher(),context);\n return addHookData([usePostsHook, useAppSettingsHook], {});\n } catch (e) {\n return handleError(e, context);\n }\n}\n")),(0,r.kt)("h4",{id:"type-parameters-8"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"[key: string]"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),"; }")))),(0,r.kt)("h4",{id:"parameters-13"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"_hookStates")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#hookstate"},(0,r.kt)("inlineCode",{parentName:"a"},"HookState")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Entity")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Entity"),"[]",">",">","[]"),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"nextProps")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#nextjsprops"},(0,r.kt)("inlineCode",{parentName:"a"},"NextJSProps")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Any additional props to pass to Next.js page routes.")))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"notFound?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"fallback"),": {} ; ",(0,r.kt)("inlineCode",{parentName:"td"},"seo"),": { ",(0,r.kt)("inlineCode",{parentName:"td"},"yoast_head"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," = seo; ",(0,r.kt)("inlineCode",{parentName:"td"},"yoast_head_json"),": {} = seo","_","json } ; ",(0,r.kt)("inlineCode",{parentName:"td"},"themeJSON"),": {} }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props.fallback")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{}")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props.seo")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"yoast_head"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," = seo; ",(0,r.kt)("inlineCode",{parentName:"td"},"yoast_head_json"),": {} = seo","_","json }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props.seo.yoast_head")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props.seo.yoast_head_json")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{}")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props.themeJSON")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{}")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"redirect?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Redirect"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"revalidate?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/server/addHookData.ts#L59"},"packages/next/src/data/server/addHookData.ts:59")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"converttopath"},"convertToPath"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"convertToPath"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"args"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Creates a path from array of arguments"),(0,r.kt)("h4",{id:"parameters-14"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Array of catch-all arguments")))),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/convertToPath.ts#L8"},"packages/next/src/data/convertToPath.ts:8")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fetchhookdata"},"fetchHookData"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"fetchHookData"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"R"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"fetchStrategy"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"ctx"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"additionalCacheObjects"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"data"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"R"),">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"isMainQuery"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }",">"),(0,r.kt)("p",null,"A function that implements data fetching on the server. This should be used in ",(0,r.kt)("inlineCode",{parentName:"p"},"getServerSideProps"),"\nor ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticProps"),"."),(0,r.kt)("p",null,"Data fetching will be performed by the specified strategy and URL params will be automatically extracted\nfrom `context"),(0,r.kt)("h4",{id:"usage-7"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"export async function getServerSideProps(context) {\n try {\n const usePostsHook = await fetchHookData(usePosts.fetcher(),context);\n\n return addHookData([usePostsHook], {});\n } catch (e) {\n return handleError(e, context);\n }\n}\xb4\n")),(0,r.kt)("p",null,"@param fetchStrategy The fetch strategy to use. Typically this is exposed by the hook e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts.fetcher()"),"\n@param ctx The Next.js context, either the one from ",(0,r.kt)("inlineCode",{parentName:"p"},"getServerSideProps")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticProps"),"\n@param options See {@link FetchHookDataOptions}"),(0,r.kt)("p",null,"@returns An object with a key of ",(0,r.kt)("inlineCode",{parentName:"p"},"data")," and a value of the fetched data."),(0,r.kt)("h4",{id:"type-parameters-9"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"unknown"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"EndpointParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"EndpointParams"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"R")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))))),(0,r.kt)("h4",{id:"parameters-15"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetchStrategy")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AbstractFetchStrategy"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"R"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ctx")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"GetServerSidePropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),", ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),">"," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"GetStaticPropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),", ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_next.FetchHookDataOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookDataOptions")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">")))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"additionalCacheObjects"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"any")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"data"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"R"),">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"isMainQuery"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"key"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }",">"),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/server/fetchHookData.ts#L124"},"packages/next/src/data/server/fetchHookData.ts:124")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"handleerror"},"handleError"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"handleError"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"ctx"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"rootRoute?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"GetServerSidePropsResult"),"<{}",">",">"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"handleError")," function is responsible for handling errors that occur during\ndata fetching in ",(0,r.kt)("inlineCode",{parentName:"p"},"getServerSideProps")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"getStaticProps"),"."),(0,r.kt)("p",null,"It also handles redirects if ",(0,r.kt)("inlineCode",{parentName:"p"},"redirectStrategy")," is set to ",(0,r.kt)("inlineCode",{parentName:"p"},"404")," in ",(0,r.kt)("inlineCode",{parentName:"p"},"headless.config.js")),(0,r.kt)("p",null,"If ",(0,r.kt)("inlineCode",{parentName:"p"},"error")," is of type NotFoundError it will redirect to the 404 page. Otherwise it will\nreturn a server error (500) page"),(0,r.kt)("h4",{id:"usage-8"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"export async function getServerSideProps(context) {\n try {\n const usePostsHook = await fetchHookData(usePosts.fetcher(),context);\n return addHookData([usePostsHook], {});\n } catch (e) {\n return handleError(e, context);\n }\n}\n")),(0,r.kt)("h4",{id:"parameters-16"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The error object")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ctx")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#headlessgetserversidepropscontext"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessGetServerSidePropsContext")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"),">"," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#headlessgetstaticpropspropscontext"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessGetStaticPropsPropsContext")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The Next.js context")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"rootRoute")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The root route (deprecated/unnecessary). This needs to be revisited")))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"GetServerSidePropsResult"),"<{}",">",">"),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/server/handleError.ts#L62"},"packages/next/src/data/server/handleError.ts:62")),(0,r.kt)("h2",{id:"other"},"Other"),(0,r.kt)("h3",{id:"headlessappprops"},"HeadlessAppProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HeadlessAppProps"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The props supported by ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#headlessapp"},"HeadlessApp"),"."),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"children?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ReactNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"handleYoast?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If true, will automatically load yoast seo metadata into the head ",(0,r.kt)("strong",{parentName:"td"},(0,r.kt)("inlineCode",{parentName:"strong"},"Default"))," true")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"pageProps")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The page props from next.js. It should contain ",(0,r.kt)("inlineCode",{parentName:"td"},"fallback"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"themeJson")," and other props. Those props are added when using ",(0,r.kt)("inlineCode",{parentName:"td"},"fetchHookData")," and ",(0,r.kt)("inlineCode",{parentName:"td"},"addHookData")," ",(0,r.kt)("strong",{parentName:"td"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))," - ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#fetchhookdata"},"fetchHookData")," - ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#addhookdata"},"addHookData"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"settings")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SettingsContextProps")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Supported settings by the framework. Such as custom image component, custom link component etc. ",(0,r.kt)("strong",{parentName:"td"},(0,r.kt)("inlineCode",{parentName:"strong"},"See"))," SettingsContextProps")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"swrConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"DataFetchingProviderProps"),"[",(0,r.kt)("inlineCode",{parentName:"td"},'"swrConfig"'),"]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Pass any configuration to the SWR library. Globally. These settings can be overridden at the hook level.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"useYoastHtml?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"If true, will make the Yoast component use the ",(0,r.kt)("inlineCode",{parentName:"td"},"yoast_head")," raw html to populate meta tags instead of ",(0,r.kt)("inlineCode",{parentName:"td"},"yoast_head_json"),". ",(0,r.kt)("inlineCode",{parentName:"td"},"yoast_head")," is the default and preferable option.")))),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/components/HeadlessApp.tsx#L18"},"packages/next/src/components/HeadlessApp.tsx:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"headlessgetserversideprops"},"HeadlessGetServerSideProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HeadlessGetServerSideProps"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"GetServerSideProps"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),">"),(0,r.kt)("h4",{id:"type-parameters-10"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Object")," = { ",(0,r.kt)("inlineCode",{parentName:"td"},"[key: string]"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),"; }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Q")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"))))),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/types.ts#L16"},"packages/next/src/data/types.ts:16")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"headlessgetserversidepropscontext"},"HeadlessGetServerSidePropsContext"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HeadlessGetServerSidePropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"GetServerSidePropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),">"),(0,r.kt)("h4",{id:"type-parameters-11"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Q")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"))))),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/types.ts#L10"},"packages/next/src/data/types.ts:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"headlessgetstaticprops"},"HeadlessGetStaticProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HeadlessGetStaticProps"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"GetStaticProps"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),">"),(0,r.kt)("h4",{id:"type-parameters-12"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Object")," = { ",(0,r.kt)("inlineCode",{parentName:"td"},"[key: string]"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),"; }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Q")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"))))),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/types.ts#L21"},"packages/next/src/data/types.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"headlessgetstaticpropspropscontext"},"HeadlessGetStaticPropsPropsContext"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HeadlessGetStaticPropsPropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"GetStaticPropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Q"),", ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),">"),(0,r.kt)("h4",{id:"type-parameters-13"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Q")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"))))),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/types.ts#L13"},"packages/next/src/data/types.ts:13")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hookstate"},"HookState"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"HookState"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-parameters-14"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))))),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"additionalCacheObjects?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#hookstate"},(0,r.kt)("inlineCode",{parentName:"a"},"HookState")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">","[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isMainQuery")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/server/addHookData.ts#L10"},"packages/next/src/data/server/addHookData.ts:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"nextjsprops"},"NextJSProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"NextJSProps"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">",": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-parameters-15"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P"))))),(0,r.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"notFound?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"redirect?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Redirect"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"revalidate?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/server/addHookData.ts#L17"},"packages/next/src/data/server/addHookData.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"previewdata"},"PreviewData"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"PreviewData"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The shape of the preview data that's stored in the preview data cookie"),(0,r.kt)("h4",{id:"index-signature"},"Index signature"),(0,r.kt)("p",null,"\u25aa ","[k: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"authToken")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The auth token that should be used to fetch the data")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The id of the resource")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"postType")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The post type")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"revision")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Whether the preview data is on a revision")))),(0,r.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/handlers/types.ts#L4"},"packages/next/src/handlers/types.ts:4")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"previewhandleroptions"},"PreviewHandlerOptions"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"PreviewHandlerOptions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The options supported by ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#previewhandler"},"previewHandler")),(0,r.kt)("h4",{id:"type-declaration-4"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"getRedirectPath?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"defaultRedirectPath"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"post"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"postTypeDef"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"CustomPostType"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"onRedirect?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"req"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"NextApiRequest"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"res"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"NextApiResponse"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"previewData"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),", ",(0,r.kt)("inlineCode",{parentName:"td"},"defaultRedirect?"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewhandleroptions"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewHandlerOptions")),"[",(0,r.kt)("inlineCode",{parentName:"td"},'"onRedirect"'),"]",", ",(0,r.kt)("inlineCode",{parentName:"td"},"redirectpath?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string"),") => ",(0,r.kt)("inlineCode",{parentName:"td"},"void"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"preparePreviewData?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"(",(0,r.kt)("inlineCode",{parentName:"td"},"req"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"NextApiRequest"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"res"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"NextApiResponse"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"post"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"PostEntity"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"previewData"),": ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),") => ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")))))),(0,r.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/handlers/previewHandler.ts#L11"},"packages/next/src/handlers/previewHandler.ts:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"vipcustomimageloader"},"VIPCustomImageLoader"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"VIPCustomImageLoader"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ImageLoaderProps")," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"aspectRatio?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }"),(0,r.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/components/ImageComponent.tsx#L30"},"packages/next/src/components/ImageComponent.tsx:30")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"seokey"},"seoKey"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"seoKey"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"@seo"')),(0,r.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/hooks/useSeo.ts#L3"},"packages/next/src/data/hooks/useSeo.ts:3")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"vipimageloader"},"VIPImageLoader"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"VIPImageLoader"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Custom Image loader for WordPress VIP leveraging Photon's API. This can't be made\na global loader because of the local loader used on the custom image component."),(0,r.kt)("h4",{id:"parameters-17"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#vipcustomimageloader"},(0,r.kt)("inlineCode",{parentName:"a"},"VIPCustomImageLoader"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The loader props")))),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/components/ImageComponent.tsx#L42"},"packages/next/src/components/ImageComponent.tsx:42")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"converturl"},"convertUrl"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"convertUrl"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"hostUrl"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"parameters-18"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"hostUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"returns-19"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/components/Yoast.tsx#L15"},"packages/next/src/components/Yoast.tsx:15")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getpathname"},"getPathName"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getPathName"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"resolvedUrl"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Extracts the path name out of the Next.js resolvedUrl"),(0,r.kt)("h4",{id:"parameters-19"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"resolvedUrl")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The full resolved URL")))),(0,r.kt)("h4",{id:"returns-20"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/server/handleError.ts#L23"},"packages/next/src/data/server/handleError.ts:23")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getsitefromcontext"},"getSiteFromContext"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getSiteFromContext"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"ctx"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"HeadlessConfig")," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"p"},"customPostTypes"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"CustomPostTypes")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"customTaxonomies"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"CustomTaxonomies")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"debug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"p"},"devMode?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"redirects?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"requests?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"hostUrl"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"integrations"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Integrations")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"preview"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"PreviewConfig")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"redirectStrategy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"RedirectStrategy")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"sites"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"HeadlessConfig"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"useWordPressPlugin"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," }"),(0,r.kt)("p",null,"Get site using context"),(0,r.kt)("h4",{id:"parameters-20"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ctx")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"GetServerSidePropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"PreviewData"),">"," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"GetStaticPropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"ParsedUrlQuery"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"PreviewData"),">")))),(0,r.kt)("h4",{id:"returns-21"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"HeadlessConfig")," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"p"},"customPostTypes"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"CustomPostTypes")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"customTaxonomies"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"CustomTaxonomies")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"debug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," { ",(0,r.kt)("inlineCode",{parentName:"p"},"devMode?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"redirects?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"requests?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"hostUrl"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"integrations"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Integrations")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"preview"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"PreviewConfig")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"redirectStrategy"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"RedirectStrategy")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"sites"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"HeadlessConfig"),"[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"sourceUrl"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"useWordPressPlugin"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," }"),(0,r.kt)("p",null,"HeadlessConfig"),(0,r.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/server/getSiteFromContext.ts#L10"},"packages/next/src/data/server/getSiteFromContext.ts:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"preparefetchhookdata"},"prepareFetchHookData"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"prepareFetchHookData"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"R"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"fetchStrategy"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"ctx"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Prepares all the things for fetchHookData"),(0,r.kt)("h4",{id:"type-parameters-16"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"unknown"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"EndpointParams")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"EndpointParams"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"R")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))))),(0,r.kt)("h4",{id:"parameters-21"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetchStrategy")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"AbstractFetchStrategy"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The fetch strategy to use. Typically this is exposed by the hook e.g: ",(0,r.kt)("inlineCode",{parentName:"td"},"usePosts.fetcher()"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"ctx")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"GetServerSidePropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),", ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),">"," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"GetStaticPropsContext"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"any"),", ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#previewdata"},(0,r.kt)("inlineCode",{parentName:"a"},"PreviewData")),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The Next.js context, either the one from ",(0,r.kt)("inlineCode",{parentName:"td"},"getServerSideProps")," or ",(0,r.kt)("inlineCode",{parentName:"td"},"getStaticProps"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_next.FetchHookDataOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookDataOptions")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"See ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_next.FetchHookDataOptions"},"FetchHookDataOptions"))))),(0,r.kt)("h4",{id:"returns-22"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The various things fetchHookData needs"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"cacheKey")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"args"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," } ; ",(0,r.kt)("inlineCode",{parentName:"td"},"url"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"cacheKey.args")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,r.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"cacheKey.url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"urlParams")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,r.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/server/fetchHookData.ts#L61"},"packages/next/src/data/server/fetchHookData.ts:61")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usepreparefetch"},"usePrepareFetch"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"usePrepareFetch"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"_params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Prepares params and options for useFetch hooks"),(0,r.kt)("h4",{id:"type-parameters-17"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Entity")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Entity"),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"EndpointParams"))))),(0,r.kt)("h4",{id:"parameters-22"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"_params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The fetch params")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The fetch options")))),(0,r.kt)("h4",{id:"returns-23"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"FetchHookOptions"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"FetchResponse"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/hooks/usePrepareFetch.ts#L13"},"packages/next/src/data/hooks/usePrepareFetch.ts:13")),(0,r.kt)("h2",{id:"react-components"},"React Components"),(0,r.kt)("h3",{id:"headlessapp"},"HeadlessApp"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"HeadlessApp"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The HeadlessApp component is the top level component for the Headless framework."),(0,r.kt)("p",null,"Should be used in ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/_app.js")),(0,r.kt)("h4",{id:"usage-9"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},'import { HeadlessApp } from "@headstartwp/next";\n\nconst MyApp = ({ Component, pageProps }) => {\n const { fallback = {}, themeJson = {}, ...props } = pageProps;\n\n return (\n \n \n \n \n \n );\n};\n\nexport default MyApp;\n')),(0,r.kt)("h4",{id:"parameters-23"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#headlessappprops"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessAppProps"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component props. See ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_next#headlessappprops"},"HeadlessAppProps"))))),(0,r.kt)("h4",{id:"returns-24"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/components/HeadlessApp.tsx#L96"},"packages/next/src/components/HeadlessApp.tsx:96")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"imagecomponent"},"ImageComponent"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ImageComponent"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"An implementation of the ImageBlock (core/image)."),(0,r.kt)("p",null,"If ",(0,r.kt)("inlineCode",{parentName:"p"},"width"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"height")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"src")," are not provided, this component will not be used."),(0,r.kt)("h4",{id:"usage-10"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},'import { BlocksRenderer, ImageBlock } from "@headstartwp/core/react";\nimport { ImageComponent } from "@headstartwp/next";\n\n\n \n\n')),(0,r.kt)("h4",{id:"parameters-24"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_next.ImageProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ImageProps"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"ImageBlockProps")))),(0,r.kt)("h4",{id:"returns-25"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/components/ImageComponent.tsx#L98"},"packages/next/src/components/ImageComponent.tsx:98")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"linkblock"},"LinkBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"LinkBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The Link Block converts a anchor tag node into a next/link component if it's an internal link"),(0,r.kt)("h4",{id:"usage-11"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},'import { BlocksRenderer } from "@headstartwp/core/react";\nimport { LinkBlock } from "@headstartwp/next";\n\n\n \n\n')),(0,r.kt)("h4",{id:"parameters-25"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Omit"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"IBlock"),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_next.LinkBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"LinkBlockProps")),">",", ",(0,r.kt)("inlineCode",{parentName:"td"},'"component"'),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Link Block Props")))),(0,r.kt)("h4",{id:"returns-26"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The next/link component"),(0,r.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/blocks/LinkBlock.tsx#L33"},"packages/next/src/blocks/LinkBlock.tsx:33")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"twitterblock"},"TwitterBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"TwitterBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"Renders a twitter embed"),(0,r.kt)("h4",{id:"usage-12"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},'import { BlocksRenderer } from "@headstartwp/core/react";\nimport { TwitterBlock } from "@headstartwp/next";\n\n\n \n\n')),(0,r.kt)("h4",{id:"parameters-26"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Omit"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"IBlock"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"IBlockAttributes"),">",", ",(0,r.kt)("inlineCode",{parentName:"td"},'"component"'),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Link Block Props")))),(0,r.kt)("h4",{id:"returns-27"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/blocks/TwitterBlock.tsx#L25"},"packages/next/src/blocks/TwitterBlock.tsx:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast"},"Yoast"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"Yoast"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The Yoast component renders the Yoast SEO meta tags.\nThis component is automatically rendered by ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#headlessapp"},"HeadlessApp")," so you don't have to manually render it."),(0,r.kt)("h4",{id:"parameters-27"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Props")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component props. Expects a single ",(0,r.kt)("inlineCode",{parentName:"td"},"seo")," prop")))),(0,r.kt)("h4",{id:"returns-28"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-39"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/components/Yoast.tsx#L63"},"packages/next/src/components/Yoast.tsx:63")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/46c017ad.92a5773d.js b/assets/js/46c017ad.6d199e1e.js similarity index 97% rename from assets/js/46c017ad.92a5773d.js rename to assets/js/46c017ad.6d199e1e.js index 118a94c9b..19123dc72 100644 --- a/assets/js/46c017ad.92a5773d.js +++ b/assets/js/46c017ad.6d199e1e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2398],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>N});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function p(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var o=n.createContext({}),s=function(e){var t=n.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=s(e.components);return n.createElement(o.Provider,{value:t},e.children)},m="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},c=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,p=e.originalType,o=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),m=s(a),c=r,N=m["".concat(o,".").concat(c)]||m[c]||k[c]||p;return a?n.createElement(N,i(i({ref:t},d),{},{components:a})):n.createElement(N,i({ref:t},d))}));function N(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var p=a.length,i=new Array(p);i[0]=c;var l={};for(var o in t)hasOwnProperty.call(t,o)&&(l[o]=t[o]);l.originalType=e,l[m]="string"==typeof e?e:r,i[1]=l;for(var s=2;s{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>m,frontMatter:()=>p,metadata:()=>l,toc:()=>s});var n=a(7462),r=(a(7294),a(3905));const p={id:"headstartwp_core.react",title:"Namespace: react",sidebar_label:"@headstartwp/core.react",custom_edit_url:null},i=void 0,l={unversionedId:"namespaces/headstartwp_core.react",id:"namespaces/headstartwp_core.react",title:"Namespace: react",description:"@headstartwp/core.react",source:"@site/docs/namespaces/headstartwp_core.react.md",sourceDirName:"namespaces",slug:"/namespaces/headstartwp_core.react",permalink:"/docs/api/namespaces/headstartwp_core.react",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react",title:"Namespace: react",sidebar_label:"@headstartwp/core.react",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/next",permalink:"/docs/api/modules/headstartwp_next"},next:{title:"@headstartwp/next.config",permalink:"/docs/api/namespaces/headstartwp_next.config"}},o={},s=[{value:"@headstartwp/core/react",id:"headstartwpcorereact",level:2},{value:"Usage",id:"usage",level:3},{value:"Interfaces",id:"interfaces",level:2},{value:"Blocks",id:"blocks",level:2},{value:"AudioBlock",id:"audioblock",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"ButtonBlock",id:"buttonblock",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"ButtonsBlock",id:"buttonsblock",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"CodeBlock",id:"codeblock",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Data Fetching Hooks",id:"data-fetching-hooks",level:2},{value:"useFetch",id:"usefetch",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"useFetchAppSettings",id:"usefetchappsettings",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"useFetchMenu",id:"usefetchmenu",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"useFetchPosts",id:"usefetchposts",level:3},{value:"Type parameters",id:"type-parameters-2",level:4},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"useFetchSearch",id:"usefetchsearch",level:3},{value:"Type parameters",id:"type-parameters-3",level:4},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"useFetchSearchNative",id:"usefetchsearchnative",level:3},{value:"Type parameters",id:"type-parameters-4",level:4},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"useFetchTerms",id:"usefetchterms",level:3},{value:"Type parameters",id:"type-parameters-5",level:4},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"Other",id:"other",level:2},{value:"Align",id:"align",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"Border",id:"border",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"DataFetchingProviderProps",id:"datafetchingproviderprops",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"ItemWrapper",id:"itemwrapper",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Parameters",id:"parameters-11",level:5},{value:"Returns",id:"returns-11",level:5},{value:"Defined in",id:"defined-in-14",level:4},{value:"ItemWrapperProps",id:"itemwrapperprops",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"LinkWrapper",id:"linkwrapper",level:3},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Parameters",id:"parameters-12",level:5},{value:"Returns",id:"returns-12",level:5},{value:"Defined in",id:"defined-in-16",level:4},{value:"LinkWrapperProps",id:"linkwrapperprops",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"MenuItemsProp",id:"menuitemsprop",level:3},{value:"Type declaration",id:"type-declaration-4",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"MenuWrapper",id:"menuwrapper",level:3},{value:"Type declaration",id:"type-declaration-5",level:4},{value:"Parameters",id:"parameters-13",level:5},{value:"Returns",id:"returns-13",level:5},{value:"Defined in",id:"defined-in-19",level:4},{value:"MenuWrapperProps",id:"menuwrapperprops",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"PageType",id:"pagetype",level:3},{value:"Type declaration",id:"type-declaration-6",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"SettingsColorPalette",id:"settingscolorpalette",level:3},{value:"Type declaration",id:"type-declaration-7",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"SettingsColorPreset",id:"settingscolorpreset",level:3},{value:"Type declaration",id:"type-declaration-8",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"SettingsContextProps",id:"settingscontextprops",level:3},{value:"Defined in",id:"defined-in-24",level:4},{value:"SettingsDuotone",id:"settingsduotone",level:3},{value:"Type declaration",id:"type-declaration-9",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"SettingsDuotonePreset",id:"settingsduotonepreset",level:3},{value:"Type declaration",id:"type-declaration-10",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"SettingsGradient",id:"settingsgradient",level:3},{value:"Type declaration",id:"type-declaration-11",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"SettingsGradientPreset",id:"settingsgradientpreset",level:3},{value:"Type declaration",id:"type-declaration-12",level:4},{value:"Defined in",id:"defined-in-28",level:4},{value:"SettingsPropertiesComplete",id:"settingspropertiescomplete",level:3},{value:"Defined in",id:"defined-in-29",level:4},{value:"Spacing",id:"spacing",level:3},{value:"Type declaration",id:"type-declaration-13",level:4},{value:"Defined in",id:"defined-in-30",level:4},{value:"Style",id:"style",level:3},{value:"Type declaration",id:"type-declaration-14",level:4},{value:"Defined in",id:"defined-in-31",level:4},{value:"StylesPropertiesAndElementsComplete",id:"stylespropertiesandelementscomplete",level:3},{value:"Defined in",id:"defined-in-32",level:4},{value:"StylesPropertiesComplete",id:"stylespropertiescomplete",level:3},{value:"Defined in",id:"defined-in-33",level:4},{value:"ThemeJSON",id:"themejson",level:3},{value:"Defined in",id:"defined-in-34",level:4},{value:"SettingsContext",id:"settingscontext",level:3},{value:"Defined in",id:"defined-in-35",level:4},{value:"ThemeSettingsContext",id:"themesettingscontext",level:3},{value:"Defined in",id:"defined-in-36",level:4},{value:"defaultElement",id:"defaultelement",level:3},{value:"Defined in",id:"defined-in-37",level:4},{value:"ColumnBlock",id:"columnblock",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-38",level:4},{value:"ColumnsBlock",id:"columnsblock",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-39",level:4},{value:"CoverBlock",id:"coverblock",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-40",level:4},{value:"DataFetchingProvider",id:"datafetchingprovider",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-41",level:4},{value:"DebugBlock",id:"debugblock",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Defined in",id:"defined-in-42",level:4},{value:"FileBlock",id:"fileblock",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Defined in",id:"defined-in-43",level:4},{value:"GroupBlock",id:"groupblock",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-20",level:4},{value:"Defined in",id:"defined-in-44",level:4},{value:"HeadingBlock",id:"headingblock",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-21",level:4},{value:"Defined in",id:"defined-in-45",level:4},{value:"ImageBlock",id:"imageblock",level:3},{value:"Parameters",id:"parameters-22",level:4},{value:"Returns",id:"returns-22",level:4},{value:"Defined in",id:"defined-in-46",level:4},{value:"ListBlock",id:"listblock",level:3},{value:"Parameters",id:"parameters-23",level:4},{value:"Returns",id:"returns-23",level:4},{value:"Defined in",id:"defined-in-47",level:4},{value:"MediaTextBlock",id:"mediatextblock",level:3},{value:"Parameters",id:"parameters-24",level:4},{value:"Returns",id:"returns-24",level:4},{value:"Defined in",id:"defined-in-48",level:4},{value:"Menu",id:"menu",level:3},{value:"Parameters",id:"parameters-25",level:4},{value:"Returns",id:"returns-25",level:4},{value:"Defined in",id:"defined-in-49",level:4},{value:"MenuItems",id:"menuitems",level:3},{value:"Parameters",id:"parameters-26",level:4},{value:"Returns",id:"returns-26",level:4},{value:"Defined in",id:"defined-in-50",level:4},{value:"ParagraphBlock",id:"paragraphblock",level:3},{value:"Parameters",id:"parameters-27",level:4},{value:"Returns",id:"returns-27",level:4},{value:"Defined in",id:"defined-in-51",level:4},{value:"PreformattedBlock",id:"preformattedblock",level:3},{value:"Parameters",id:"parameters-28",level:4},{value:"Returns",id:"returns-28",level:4},{value:"Defined in",id:"defined-in-52",level:4},{value:"PullQuoteBlock",id:"pullquoteblock",level:3},{value:"Parameters",id:"parameters-29",level:4},{value:"Returns",id:"returns-29",level:4},{value:"Defined in",id:"defined-in-53",level:4},{value:"QuoteBlock",id:"quoteblock",level:3},{value:"Parameters",id:"parameters-30",level:4},{value:"Returns",id:"returns-30",level:4},{value:"Defined in",id:"defined-in-54",level:4},{value:"SeparatorBlock",id:"separatorblock",level:3},{value:"Parameters",id:"parameters-31",level:4},{value:"Returns",id:"returns-31",level:4},{value:"Defined in",id:"defined-in-55",level:4},{value:"SettingsProvider",id:"settingsprovider",level:3},{value:"Parameters",id:"parameters-32",level:4},{value:"Returns",id:"returns-32",level:4},{value:"Defined in",id:"defined-in-56",level:4},{value:"SpacerBlock",id:"spacerblock",level:3},{value:"Parameters",id:"parameters-33",level:4},{value:"Returns",id:"returns-33",level:4},{value:"Defined in",id:"defined-in-57",level:4},{value:"TableBlock",id:"tableblock",level:3},{value:"Parameters",id:"parameters-34",level:4},{value:"Returns",id:"returns-34",level:4},{value:"Defined in",id:"defined-in-58",level:4},{value:"ThemeSettingsProvider",id:"themesettingsprovider",level:3},{value:"Parameters",id:"parameters-35",level:4},{value:"Returns",id:"returns-35",level:4},{value:"Defined in",id:"defined-in-59",level:4},{value:"VerseBlock",id:"verseblock",level:3},{value:"Parameters",id:"parameters-36",level:4},{value:"Returns",id:"returns-36",level:4},{value:"Defined in",id:"defined-in-60",level:4},{value:"YoutubeLiteBlock",id:"youtubeliteblock",level:3},{value:"Parameters",id:"parameters-37",level:4},{value:"Returns",id:"returns-37",level:4},{value:"Defined in",id:"defined-in-61",level:4},{value:"getAlignStyle",id:"getalignstyle",level:3},{value:"Parameters",id:"parameters-38",level:4},{value:"Returns",id:"returns-38",level:4},{value:"Defined in",id:"defined-in-62",level:4},{value:"getBlockStyle",id:"getblockstyle",level:3},{value:"Parameters",id:"parameters-39",level:4},{value:"Returns",id:"returns-39",level:4},{value:"Defined in",id:"defined-in-63",level:4},{value:"getColorStyles",id:"getcolorstyles",level:3},{value:"Parameters",id:"parameters-40",level:4},{value:"Returns",id:"returns-40",level:4},{value:"Defined in",id:"defined-in-64",level:4},{value:"getInlineStyles",id:"getinlinestyles",level:3},{value:"Parameters",id:"parameters-41",level:4},{value:"Returns",id:"returns-41",level:4},{value:"Defined in",id:"defined-in-65",level:4},{value:"getTypographyStyles",id:"gettypographystyles",level:3},{value:"Parameters",id:"parameters-42",level:4},{value:"Returns",id:"returns-42",level:4},{value:"Defined in",id:"defined-in-66",level:4},{value:"getWidthStyles",id:"getwidthstyles",level:3},{value:"Parameters",id:"parameters-43",level:4},{value:"Returns",id:"returns-43",level:4},{value:"Defined in",id:"defined-in-67",level:4},{value:"parseSeo",id:"parseseo",level:3},{value:"Parameters",id:"parameters-44",level:4},{value:"Returns",id:"returns-44",level:4},{value:"Defined in",id:"defined-in-68",level:4},{value:"safeArraySpread",id:"safearrayspread",level:3},{value:"Parameters",id:"parameters-45",level:4},{value:"Returns",id:"returns-45",level:4},{value:"Defined in",id:"defined-in-69",level:4},{value:"serializeKey",id:"serializekey",level:3},{value:"Parameters",id:"parameters-46",level:4},{value:"Returns",id:"returns-46",level:4},{value:"Defined in",id:"defined-in-70",level:4},{value:"useBlock",id:"useblock",level:3},{value:"Type parameters",id:"type-parameters-6",level:4},{value:"Parameters",id:"parameters-47",level:4},{value:"Returns",id:"returns-47",level:4},{value:"Defined in",id:"defined-in-71",level:4},{value:"useBlockAlign",id:"useblockalign",level:3},{value:"Parameters",id:"parameters-48",level:4},{value:"Returns",id:"returns-48",level:4},{value:"Defined in",id:"defined-in-72",level:4},{value:"useBlockAttributes",id:"useblockattributes",level:3},{value:"Parameters",id:"parameters-49",level:4},{value:"Returns",id:"returns-49",level:4},{value:"Defined in",id:"defined-in-73",level:4},{value:"useBlockBorder",id:"useblockborder",level:3},{value:"Parameters",id:"parameters-50",level:4},{value:"Returns",id:"returns-50",level:4},{value:"Defined in",id:"defined-in-74",level:4},{value:"useBlockColors",id:"useblockcolors",level:3},{value:"Parameters",id:"parameters-51",level:4},{value:"Returns",id:"returns-51",level:4},{value:"Defined in",id:"defined-in-75",level:4},{value:"useBlockSpacing",id:"useblockspacing",level:3},{value:"Parameters",id:"parameters-52",level:4},{value:"Returns",id:"returns-52",level:4},{value:"Defined in",id:"defined-in-76",level:4},{value:"useBlockStyle",id:"useblockstyle",level:3},{value:"Parameters",id:"parameters-53",level:4},{value:"Returns",id:"returns-53",level:4},{value:"Defined in",id:"defined-in-77",level:4},{value:"useBlockTypography",id:"useblocktypography",level:3},{value:"Parameters",id:"parameters-54",level:4},{value:"Returns",id:"returns-54",level:4},{value:"Defined in",id:"defined-in-78",level:4},{value:"useBlockWidth",id:"useblockwidth",level:3},{value:"Parameters",id:"parameters-55",level:4},{value:"Returns",id:"returns-55",level:4},{value:"Defined in",id:"defined-in-79",level:4},{value:"useFetchAuthorArchive",id:"usefetchauthorarchive",level:3},{value:"Type parameters",id:"type-parameters-7",level:4},{value:"Parameters",id:"parameters-56",level:4},{value:"Returns",id:"returns-56",level:4},{value:"Defined in",id:"defined-in-80",level:4},{value:"useFetchPost",id:"usefetchpost",level:3},{value:"Type parameters",id:"type-parameters-8",level:4},{value:"Parameters",id:"parameters-57",level:4},{value:"Returns",id:"returns-57",level:4},{value:"Defined in",id:"defined-in-81",level:4},{value:"useFetchPostOrPosts",id:"usefetchpostorposts",level:3},{value:"Type parameters",id:"type-parameters-9",level:4},{value:"Parameters",id:"parameters-58",level:4},{value:"Returns",id:"returns-58",level:4},{value:"Defined in",id:"defined-in-82",level:4},{value:"useSWR",id:"useswr",level:3},{value:"Type parameters",id:"type-parameters-10",level:4},{value:"Parameters",id:"parameters-59",level:4},{value:"Returns",id:"returns-59",level:4},{value:"Defined in",id:"defined-in-83",level:4},{value:"Type parameters",id:"type-parameters-11",level:4},{value:"Parameters",id:"parameters-60",level:4},{value:"Returns",id:"returns-60",level:4},{value:"Defined in",id:"defined-in-84",level:4},{value:"Type parameters",id:"type-parameters-12",level:4},{value:"Parameters",id:"parameters-61",level:4},{value:"Returns",id:"returns-61",level:4},{value:"Defined in",id:"defined-in-85",level:4},{value:"Type parameters",id:"type-parameters-13",level:4},{value:"Parameters",id:"parameters-62",level:4},{value:"Returns",id:"returns-62",level:4},{value:"Defined in",id:"defined-in-86",level:4},{value:"Type parameters",id:"type-parameters-14",level:4},{value:"Parameters",id:"parameters-63",level:4},{value:"Returns",id:"returns-63",level:4},{value:"Defined in",id:"defined-in-87",level:4},{value:"Type parameters",id:"type-parameters-15",level:4},{value:"Parameters",id:"parameters-64",level:4},{value:"Returns",id:"returns-64",level:4},{value:"Defined in",id:"defined-in-88",level:4},{value:"Type parameters",id:"type-parameters-16",level:4},{value:"Parameters",id:"parameters-65",level:4},{value:"Returns",id:"returns-65",level:4},{value:"Defined in",id:"defined-in-89",level:4},{value:"Type parameters",id:"type-parameters-17",level:4},{value:"Parameters",id:"parameters-66",level:4},{value:"Returns",id:"returns-66",level:4},{value:"Defined in",id:"defined-in-90",level:4},{value:"useSWRConfig",id:"useswrconfig",level:3},{value:"Returns",id:"returns-67",level:4},{value:"Defined in",id:"defined-in-91",level:4},{value:"useSettings",id:"usesettings",level:3},{value:"Returns",id:"returns-68",level:4},{value:"Defined in",id:"defined-in-92",level:4},{value:"useThemeSetting",id:"usethemesetting",level:3},{value:"Parameters",id:"parameters-67",level:4},{value:"Returns",id:"returns-69",level:4},{value:"Defined in",id:"defined-in-93",level:4},{value:"useThemeSettings",id:"usethemesettings",level:3},{value:"Returns",id:"returns-70",level:4},{value:"Defined in",id:"defined-in-94",level:4},{value:"useThemeStyles",id:"usethemestyles",level:3},{value:"Returns",id:"returns-71",level:4},{value:"Defined in",id:"defined-in-95",level:4},{value:"React Components",id:"react-components",level:2},{value:"BlocksRenderer",id:"blocksrenderer",level:3},{value:"Usage",id:"usage-1",level:4},{value:"Usage with the test function",id:"usage-with-the-test-function",level:5},{value:"Usage with classList and tagName props",id:"usage-with-classlist-and-tagname-props",level:5},{value:"Parameters",id:"parameters-68",level:4},{value:"Returns",id:"returns-72",level:4},{value:"Defined in",id:"defined-in-96",level:4},{value:"HtmlDecoder",id:"htmldecoder",level:3},{value:"Usage",id:"usage-2",level:4},{value:"Parameters",id:"parameters-69",level:4},{value:"Returns",id:"returns-73",level:4},{value:"Defined in",id:"defined-in-97",level:4},{value:"SafeHtml",id:"safehtml",level:3},{value:"Usage",id:"usage-3",level:4},{value:"Parameters",id:"parameters-70",level:4},{value:"Returns",id:"returns-74",level:4},{value:"Defined in",id:"defined-in-98",level:4}],d={toc:s};function m(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".react"),(0,r.kt)("h2",{id:"headstartwpcorereact"},"@headstartwp/core/react"),(0,r.kt)("p",null,"The react export of the ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/core")," package."),(0,r.kt)("h3",{id:"usage"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},'import { BlocksRenderer } from "@headstartwp/core/react";\n')),(0,r.kt)("h2",{id:"interfaces"},"Interfaces"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps"},"AudioBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.BlockAttributes"},"BlockAttributes")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.BlockProps"},"BlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.BlockRendererProps"},"BlockRendererProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps"},"ButtonBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps"},"ButtonsBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps"},"CodeBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps"},"ColumnBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps"},"ColumnsBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps"},"CoverBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},"FetchHookOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps"},"FileBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps"},"GroupBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.GutenbergBlockProps"},"GutenbergBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps"},"HeadingBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.HtmlDecodeProps"},"HtmlDecodeProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IAudioBlock"},"IAudioBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IButtonBlock"},"IButtonBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IButtonsBlock"},"IButtonsBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ICodeBlock"},"ICodeBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IColumnBlock"},"IColumnBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IColumnsBlock"},"IColumnsBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ICoverBlock"},"ICoverBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IDataWPBlock"},"IDataWPBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IFileBlock"},"IFileBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IGroupBlock"},"IGroupBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IHeadingBlock"},"IHeadingBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IImageBlock"},"IImageBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IListBlock"},"IListBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IMediaTextBlock"},"IMediaTextBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IParagraphBlock"},"IParagraphBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IPreformattedBlock"},"IPreformattedBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IPullQuoteBlock"},"IPullQuoteBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IQuoteBlock"},"IQuoteBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ISeparatorBlock"},"ISeparatorBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ISpacerBlock"},"ISpacerBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ITableBlock"},"ITableBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IVerseBlock"},"IVerseBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock"},"IYoutubeLiteBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps"},"ImageBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps"},"ListBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps"},"MediaTextBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps"},"ParagraphBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps"},"PreformattedBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps"},"PullQuoteBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps"},"QuoteBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.SafeHtmlProps"},"SafeHtmlProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps"},"SeparatorBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties"},"SettingsCustomAdditionalProperties")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},"SettingsProperties")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps"},"SpacerBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete"},"StylesElementsPropertiesComplete")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"},"StylesProperties")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps"},"TableBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},"Typography")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps"},"VerseBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.WpThemeJSON"},"WpThemeJSON")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps"},"YoutubeLiteBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse"},"useAppSettingsResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.useFetchOptions"},"useFetchOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse"},"useMenuResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse"},"usePostOrPostResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.usePostResponse"},"usePostResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"},"usePostsResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.useSearchNativeResponse"},"useSearchNativeResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse"},"useSearchResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse"},"useTermsResponse"))),(0,r.kt)("h2",{id:"blocks"},"Blocks"),(0,r.kt)("h3",{id:"audioblock"},"AudioBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"AudioBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The AudioBlock components implements block parsing for the Audio block."),(0,r.kt)("p",null,"This component must be used within a ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#blocksrenderer"},"BlocksRenderer")," component."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"\n \n\n")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IAudioBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IAudioBlock"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component properties")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/AudioBlock.tsx#L58"},"packages/core/src/react/blocks/AudioBlock.tsx:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"buttonblock"},"ButtonBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ButtonBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The ButtonBlock component implements block parsing for the Button block."),(0,r.kt)("p",null,"This component must be used within a ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#blocksrenderer"},"BlocksRenderer")," component."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"\n \n\n")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IButtonBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IButtonBlock"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component properties")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/ButtonBlock.tsx#L62"},"packages/core/src/react/blocks/ButtonBlock.tsx:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"buttonsblock"},"ButtonsBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ButtonsBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The ButtonsBlock component implements block parsing for the Buttons block."),(0,r.kt)("p",null,"This component must be used within a ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#blocksrenderer"},"BlocksRenderer")," component."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"\n \n\n")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IButtonsBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IButtonsBlock"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component properties")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/ButtonsBlock.tsx#L28"},"packages/core/src/react/blocks/ButtonsBlock.tsx:28")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"codeblock"},"CodeBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"CodeBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The CodeBlock component implements block parsing for the core/code block."),(0,r.kt)("p",null,"This component must be used within a ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#blocksrenderer"},"BlocksRenderer")," component."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"\n \n\n")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ICodeBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"ICodeBlock"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component properties")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/CodeBlock.tsx#L32"},"packages/core/src/react/blocks/CodeBlock.tsx:32")),(0,r.kt)("h2",{id:"data-fetching-hooks"},"Data Fetching Hooks"),(0,r.kt)("h3",{id:"usefetch"},"useFetch"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetch"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"E"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Params"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"R"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fetchStrategy"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The use Fetch Hook is the foundation for most hooks in the headless framework. It is a wrapper around\n",(0,r.kt)("inlineCode",{parentName:"p"},"useSWR")," and provides a consistent API for fetching data from the API. It requires a fetch strategy which implements\nthe actual data fetching logic"),(0,r.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"E")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"E"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,r.kt)("inlineCode",{parentName:"a"},"EndpointParams")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"R")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"E"))))),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The list of params to pass to the fetch strategy. It overrides the ones in the URL.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetchStrategy")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,r.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"E"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Params"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The fetch strategy.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"R"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The options to pass to the swr hook.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path of the url to get url params from.")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The returned data of the fetcher function.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The error object thrown by the fetcher function.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isLoading")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isMainQuery")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isValidating")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"mutate")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"KeyedMutator"),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"R"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/useFetch.ts#L30"},"packages/core/src/react/hooks/useFetch.ts:30")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchappsettings"},"useFetchAppSettings"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchAppSettings"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useAppSettingsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useAppSettings hook"),(0,r.kt)("p",null,"See useAppSettings"),(0,r.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AppEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AppEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,r.kt)("inlineCode",{parentName:"a"},"EndpointParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,r.kt)("inlineCode",{parentName:"a"},"EndpointParams")))))),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The list of params to pass to the fetch strategy. It overrides the ones in the URL.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The options to pass to the swr hook.")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useAppSettingsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/useFetchAppSettings.ts#L21"},"packages/core/src/react/hooks/useFetchAppSettings.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchmenu"},"useFetchMenu"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchMenu"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"menuLocation"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useMenuResponse"))),(0,r.kt)("p",null,"The useFetchMenu hooks. Returns a Menu object."),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"menuLocation")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The slug of the menu location you want to fetch")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AppEntity")),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"SWR configuration options")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useMenuResponse"))),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/useFetchMenu.ts#L50"},"packages/core/src/react/hooks/useFetchMenu.ts:50")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchposts"},"useFetchPosts"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchPosts"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fetcher?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useFetchPosts hook. Returns a collection of post entities"),(0,r.kt)("p",null,"See usePosts for usage instructions."),(0,r.kt)("h4",{id:"type-parameters-2"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The list of params to pass to the fetch strategy. It overrides the ones in the URL.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The options to pass to the swr hook.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path of the url to get url params from.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetcher")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},(0,r.kt)("inlineCode",{parentName:"a"},"PostsArchiveFetchStrategy")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The fetch strategy to use. If none is passed, the default one is used")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/useFetchPosts.ts#L79"},"packages/core/src/react/hooks/useFetchPosts.ts:79")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchsearch"},"useFetchSearch"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchSearch"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useSearchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useFetchSearch hook. Returns a collection of post entities"),(0,r.kt)("p",null,"See useSearch for usage instructions."),(0,r.kt)("h4",{id:"type-parameters-3"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The list of params to pass to the fetch strategy. It overrides the ones in the URL.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The options to pass to the swr hook.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path of the url to get url params from.")))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useSearchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/useFetchSearch.ts#L32"},"packages/core/src/react/hooks/useFetchSearch.ts:32")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchsearchnative"},"useFetchSearchNative"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchSearchNative"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useSearchNativeResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useSearchNativeResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useFetchSearchNative hook. Returns a collection of search entities retrieved through the WP native search endpoint"),(0,r.kt)("p",null,"See useSearchNative for usage instructions."),(0,r.kt)("h4",{id:"type-parameters-4"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostSearchEntity"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermSearchEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermSearchEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostSearchEntity"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermSearchEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermSearchEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.SearchParams"},(0,r.kt)("inlineCode",{parentName:"a"},"SearchParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.SearchParams"},(0,r.kt)("inlineCode",{parentName:"a"},"SearchParams")))))),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The list of params to pass to the fetch strategy. It overrides the ones in the URL.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The options to pass to the swr hook.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path of the url to get url params from.")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useSearchNativeResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useSearchNativeResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/useFetchSearchNative.ts#L35"},"packages/core/src/react/hooks/useFetchSearchNative.ts:35")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchterms"},"useFetchTerms"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchTerms"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useTermsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useFetchTerms hook. Returns a collection of term entities"),(0,r.kt)("p",null,"See useTerms for usage instructions."),(0,r.kt)("h4",{id:"type-parameters-5"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"TaxonomyArchiveParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"TaxonomyArchiveParams")))))),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The list of params to pass to the fetch strategy. It overrides the ones in the URL.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The options to pass to the swr hook.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path of the url to get url params from.")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useTermsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/useFetchTerms.ts#L29"},"packages/core/src/react/hooks/useFetchTerms.ts:29")),(0,r.kt)("h2",{id:"other"},"Other"),(0,r.kt)("h3",{id:"align"},"Align"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Align"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"none"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"left"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"center"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"right"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"wide"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"full"')),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L15"},"packages/core/src/react/blocks/types.ts:15")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"border"},"Border"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Border"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"radius?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"style?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"width?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L65"},"packages/core/src/react/blocks/types.ts:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"datafetchingproviderprops"},"DataFetchingProviderProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"DataFetchingProviderProps"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRConfiguration"),"[",(0,r.kt)("inlineCode",{parentName:"td"},'"fallback"'),"]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"swrConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRConfiguration")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Pass any configuration to the SWR library. Globally. These settings can be overridden at the hook level.")))),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/DataFetchingProvider.tsx#L6"},"packages/core/src/react/provider/DataFetchingProvider.tsx:6")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"itemwrapper"},"ItemWrapper"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ItemWrapper"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#itemwrapperprops"},(0,r.kt)("inlineCode",{parentName:"a"},"ItemWrapperProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h5",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#itemwrapperprops"},(0,r.kt)("inlineCode",{parentName:"a"},"ItemWrapperProps")))))),(0,r.kt)("h5",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/Menu.tsx#L15"},"packages/core/src/react/components/Menu.tsx:15")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"itemwrapperprops"},"ItemWrapperProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ItemWrapperProps"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"PropsWithChildren"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"className"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"depth"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"item"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"MenuItemEntity"))," }",">"),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/Menu.tsx#L10"},"packages/core/src/react/components/Menu.tsx:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"linkwrapper"},"LinkWrapper"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"LinkWrapper"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#linkwrapperprops"},(0,r.kt)("inlineCode",{parentName:"a"},"LinkWrapperProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h5",{id:"parameters-12"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#linkwrapperprops"},(0,r.kt)("inlineCode",{parentName:"a"},"LinkWrapperProps")))))),(0,r.kt)("h5",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/Menu.tsx#L27"},"packages/core/src/react/components/Menu.tsx:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"linkwrapperprops"},"LinkWrapperProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"LinkWrapperProps"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"PropsWithChildren"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"depth"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"href"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }",">"),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/Menu.tsx#L23"},"packages/core/src/react/components/Menu.tsx:23")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"menuitemsprop"},"MenuItemsProp"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"MenuItemsProp"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-4"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"depth")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"itemWrapper")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#itemwrapper"},(0,r.kt)("inlineCode",{parentName:"a"},"ItemWrapper")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"items")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"MenuItemEntity")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"linkWrapper")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#linkwrapper"},(0,r.kt)("inlineCode",{parentName:"a"},"LinkWrapper")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"menuWrapper")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#menuwrapper"},(0,r.kt)("inlineCode",{parentName:"a"},"MenuWrapper")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"topLevelItemsClickable")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/Menu.tsx#L29"},"packages/core/src/react/components/Menu.tsx:29")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"menuwrapper"},"MenuWrapper"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"MenuWrapper"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#menuwrapperprops"},(0,r.kt)("inlineCode",{parentName:"a"},"MenuWrapperProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h4",{id:"type-declaration-5"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h5",{id:"parameters-13"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#menuwrapperprops"},(0,r.kt)("inlineCode",{parentName:"a"},"MenuWrapperProps")))))),(0,r.kt)("h5",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/Menu.tsx#L21"},"packages/core/src/react/components/Menu.tsx:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"menuwrapperprops"},"MenuWrapperProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"MenuWrapperProps"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"PropsWithChildren"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"className"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"depth"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," }",">"),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/Menu.tsx#L17"},"packages/core/src/react/components/Menu.tsx:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"pagetype"},"PageType"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"PageType"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-6"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isAuthorArchive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Author Archive")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isCategoryArchive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Category Archive")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isPostArchive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Regular post archive")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isPostTypeArchive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Custom Post Type Archive")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isSearch")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Search route")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isTagArchive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Tag Archive")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isTaxonomyArchive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Custom Taxonomy Archive")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"postType")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Which post type this archive is for")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"taxonomy")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Which taxonomy this archive is for")))),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/useFetchPosts.ts#L19"},"packages/core/src/react/hooks/useFetchPosts.ts:19")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingscolorpalette"},"SettingsColorPalette"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsColorPalette"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-7"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingscolorpreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsColorPreset")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"theme?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingscolorpreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsColorPreset")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"user?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingscolorpreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsColorPreset")),"[]")))),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L47"},"packages/core/src/react/provider/types.ts:47")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingscolorpreset"},"SettingsColorPreset"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsColorPreset"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-8"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"color")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"CSS hex or rgb(a) string.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Name of the color preset, translatable.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Kebab-case unique identifier for the color preset.")))),(0,r.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L32"},"packages/core/src/react/provider/types.ts:32")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingscontextprops"},"SettingsContextProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsContextProps"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"imageComponent?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"React.FC"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IImageBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IImageBlock")),">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"linkComponent?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactNode")," } & ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L5"},"packages/core/src/react/provider/types.ts:5")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingsduotone"},"SettingsDuotone"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsDuotone"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-9"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsduotonepreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsDuotonePreset")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"theme?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsduotonepreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsDuotonePreset")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"user?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsduotonepreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsDuotonePreset")),"[]")))),(0,r.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L89"},"packages/core/src/react/provider/types.ts:89")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingsduotonepreset"},"SettingsDuotonePreset"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsDuotonePreset"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-10"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"colors")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"List of colors from dark to light.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Name of the duotone preset, translatable.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Kebab-case unique identifier for the duotone preset.")))),(0,r.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L74"},"packages/core/src/react/provider/types.ts:74")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingsgradient"},"SettingsGradient"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsGradient"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-11"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsgradientpreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsGradientPreset")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"theme?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsgradientpreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsGradientPreset")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"user?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsgradientpreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsGradientPreset")),"[]")))),(0,r.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L68"},"packages/core/src/react/provider/types.ts:68")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingsgradientpreset"},"SettingsGradientPreset"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsGradientPreset"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-12"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"gradient")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"CSS gradient string.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Name of the gradient preset, translatable.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Kebab-case unique identifier for the gradient preset.")))),(0,r.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L53"},"packages/core/src/react/provider/types.ts:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingspropertiescomplete"},"SettingsPropertiesComplete"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsPropertiesComplete"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"border?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"border"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"color"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"custom?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"custom"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"layout?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"layout"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"spacing?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"spacing"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"typography?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"typography"'),"]"," }"),(0,r.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L10"},"packages/core/src/react/provider/types.ts:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"spacing"},"Spacing"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Spacing"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-13"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"blockGap")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"bottom"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"left"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"right"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"top"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.bottom")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.left")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.right")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.top")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"bottom"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"left"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"right"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"top"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.bottom")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.left")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.right")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.top")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"supportsBlockGap")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"supportsMargin")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"supportsPadding")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L40"},"packages/core/src/react/blocks/types.ts:40")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"style"},"Style"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Style"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-14"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"border")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,r.kt)("inlineCode",{parentName:"a"},"Border")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"spacing")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,r.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"typography")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,r.kt)("inlineCode",{parentName:"a"},"Typography")))))),(0,r.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L17"},"packages/core/src/react/blocks/types.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"stylespropertiesandelementscomplete"},"StylesPropertiesAndElementsComplete"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"StylesPropertiesAndElementsComplete"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesProperties"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"border?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"border"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"color"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"elements?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesElementsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"spacing?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"spacing"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"typography?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"typography"'),"]"," }"),(0,r.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L24"},"packages/core/src/react/provider/types.ts:24")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"stylespropertiescomplete"},"StylesPropertiesComplete"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"StylesPropertiesComplete"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesProperties"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"border?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"border"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"color"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"spacing?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"spacing"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"typography?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"typography"'),"]"," }"),(0,r.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L18"},"packages/core/src/react/provider/types.ts:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"themejson"},"ThemeJSON"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ThemeJSON"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Pick"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.WpThemeJSON"},(0,r.kt)("inlineCode",{parentName:"a"},"WpThemeJSON")),", ",(0,r.kt)("inlineCode",{parentName:"p"},'"styles"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"settings"'),">"),(0,r.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L352"},"packages/core/src/react/provider/types.ts:352")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingscontext"},"SettingsContext"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"SettingsContext"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Context"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingscontextprops"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsContextProps")),">",">"),(0,r.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/Provider.tsx#L5"},"packages/core/src/react/provider/Provider.tsx:5")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"themesettingscontext"},"ThemeSettingsContext"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"ThemeSettingsContext"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Context"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#themejson"},(0,r.kt)("inlineCode",{parentName:"a"},"ThemeJSON")),">"),(0,r.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/ThemeSettingsProvider.tsx#L4"},"packages/core/src/react/provider/ThemeSettingsProvider.tsx:4")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"defaultelement"},"defaultElement"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"defaultElement"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/hooks/useBlock.ts#L8"},"packages/core/src/react/blocks/hooks/useBlock.ts:8")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"columnblock"},"ColumnBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ColumnBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-14"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IColumnBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IColumnBlock")))))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/ColumnBlock.tsx#L11"},"packages/core/src/react/blocks/ColumnBlock.tsx:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"columnsblock"},"ColumnsBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ColumnsBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-15"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IColumnsBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IColumnsBlock")))))),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-39"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/ColumnsBlocks.tsx#L11"},"packages/core/src/react/blocks/ColumnsBlocks.tsx:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"coverblock"},"CoverBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"CoverBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-16"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ICoverBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"ICoverBlock")))))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-40"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/CoverBlock.tsx#L24"},"packages/core/src/react/blocks/CoverBlock.tsx:24")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"datafetchingprovider"},"DataFetchingProvider"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"DataFetchingProvider"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"context?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"parameters-17"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"PropsWithChildren"),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#datafetchingproviderprops"},(0,r.kt)("inlineCode",{parentName:"a"},"DataFetchingProviderProps")),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"context?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-41"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/react/index.d.ts:542"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"debugblock"},"DebugBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"DebugBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-18"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object"))))),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-42"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/DebugBlock.tsx#L7"},"packages/core/src/react/blocks/DebugBlock.tsx:7")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fileblock"},"FileBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"FileBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-19"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IFileBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IFileBlock")))))),(0,r.kt)("h4",{id:"returns-19"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-43"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/FileBlock.tsx#L14"},"packages/core/src/react/blocks/FileBlock.tsx:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"groupblock"},"GroupBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"GroupBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-20"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IGroupBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IGroupBlock")))))),(0,r.kt)("h4",{id:"returns-20"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-44"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/GroupBlock.tsx#L17"},"packages/core/src/react/blocks/GroupBlock.tsx:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"headingblock"},"HeadingBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"HeadingBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-21"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IHeadingBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IHeadingBlock")))))),(0,r.kt)("h4",{id:"returns-21"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-45"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/HeadingBlock.tsx#L12"},"packages/core/src/react/blocks/HeadingBlock.tsx:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"imageblock"},"ImageBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ImageBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-22"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IImageBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IImageBlock")))))),(0,r.kt)("h4",{id:"returns-22"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-46"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/ImageBlock.tsx#L19"},"packages/core/src/react/blocks/ImageBlock.tsx:19")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"listblock"},"ListBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ListBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-23"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IListBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IListBlock")))))),(0,r.kt)("h4",{id:"returns-23"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-47"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/ListBlock.tsx#L12"},"packages/core/src/react/blocks/ListBlock.tsx:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"mediatextblock"},"MediaTextBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"MediaTextBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-24"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IMediaTextBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IMediaTextBlock")))))),(0,r.kt)("h4",{id:"returns-24"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-48"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/MediaTextBlock.tsx#L22"},"packages/core/src/react/blocks/MediaTextBlock.tsx:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"menu"},"Menu"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"Menu"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-25"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"MenuProps"))))),(0,r.kt)("h4",{id:"returns-25"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-49"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/Menu.tsx#L109"},"packages/core/src/react/components/Menu.tsx:109")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"menuitems"},"MenuItems"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"MenuItems"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-26"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#menuitemsprop"},(0,r.kt)("inlineCode",{parentName:"a"},"MenuItemsProp")))))),(0,r.kt)("h4",{id:"returns-26"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-50"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/Menu.tsx#L54"},"packages/core/src/react/components/Menu.tsx:54")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"paragraphblock"},"ParagraphBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ParagraphBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-27"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IParagraphBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IParagraphBlock")))))),(0,r.kt)("h4",{id:"returns-27"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-51"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/ParagraphBlock.tsx#L13"},"packages/core/src/react/blocks/ParagraphBlock.tsx:13")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"preformattedblock"},"PreformattedBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"PreformattedBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-28"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IPreformattedBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IPreformattedBlock")))))),(0,r.kt)("h4",{id:"returns-28"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-52"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/PreformatedBlock.tsx#L11"},"packages/core/src/react/blocks/PreformatedBlock.tsx:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"pullquoteblock"},"PullQuoteBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"PullQuoteBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-29"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IPullQuoteBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IPullQuoteBlock")))))),(0,r.kt)("h4",{id:"returns-29"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-53"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/PullQuote.tsx#L15"},"packages/core/src/react/blocks/PullQuote.tsx:15")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"quoteblock"},"QuoteBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"QuoteBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-30"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IQuoteBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IQuoteBlock")))))),(0,r.kt)("h4",{id:"returns-30"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-54"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/QuoteBlock.tsx#L10"},"packages/core/src/react/blocks/QuoteBlock.tsx:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"separatorblock"},"SeparatorBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"SeparatorBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-31"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ISeparatorBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"ISeparatorBlock")))))),(0,r.kt)("h4",{id:"returns-31"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-55"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/SeparatorBlock.tsx#L10"},"packages/core/src/react/blocks/SeparatorBlock.tsx:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingsprovider"},"SettingsProvider"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"SettingsProvider"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"context?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"parameters-32"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"PropsWithChildren"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"ProviderProps"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"context?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"returns-32"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-56"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/react/index.d.ts:542"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"spacerblock"},"SpacerBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"SpacerBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-33"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ISpacerBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"ISpacerBlock")))))),(0,r.kt)("h4",{id:"returns-33"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-57"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/SpacerBlock.tsx#L12"},"packages/core/src/react/blocks/SpacerBlock.tsx:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tableblock"},"TableBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"TableBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-34"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ITableBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"ITableBlock")))))),(0,r.kt)("h4",{id:"returns-34"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-58"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/TableBlock.tsx#L12"},"packages/core/src/react/blocks/TableBlock.tsx:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"themesettingsprovider"},"ThemeSettingsProvider"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ThemeSettingsProvider"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"context?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"parameters-35"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"PropsWithChildren"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"ProviderProps"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"context?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"returns-35"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-59"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/react/index.d.ts:542"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"verseblock"},"VerseBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"VerseBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-36"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IVerseBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IVerseBlock")))))),(0,r.kt)("h4",{id:"returns-36"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-60"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/VerseBlock.tsx#L11"},"packages/core/src/react/blocks/VerseBlock.tsx:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"youtubeliteblock"},"YoutubeLiteBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"YoutubeLiteBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"Renders Youtube embeds with lite-youtube-embed"),(0,r.kt)("h4",{id:"parameters-37"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Omit"),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IYoutubeLiteBlock")),", ",(0,r.kt)("inlineCode",{parentName:"td"},'"component"'),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The Block props")))),(0,r.kt)("h4",{id:"returns-37"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-61"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/YoutubeLiteBlock.tsx#L41"},"packages/core/src/react/blocks/YoutubeLiteBlock.tsx:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getalignstyle"},"getAlignStyle"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAlignStyle"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},'"none"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"left"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"center"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"right"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"wide"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"full"')),(0,r.kt)("h4",{id:"parameters-38"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"domNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))))),(0,r.kt)("h4",{id:"returns-38"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},'"none"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"left"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"center"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"right"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"wide"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"full"')),(0,r.kt)("h4",{id:"defined-in-62"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/utils.ts#L5"},"packages/core/src/react/blocks/utils.ts:5")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getblockstyle"},"getBlockStyle"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getBlockStyle"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Returns the block style (is-style-{block-style})"),(0,r.kt)("h4",{id:"parameters-39"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"domNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-39"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"string with block style"),(0,r.kt)("h4",{id:"defined-in-63"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/utils.ts#L39"},"packages/core/src/react/blocks/utils.ts:39")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcolorstyles"},"getColorStyles"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getColorStyles"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,r.kt)("inlineCode",{parentName:"a"},"Colors"))),(0,r.kt)("p",null,"Infer GB color styles from classnames"),(0,r.kt)("h4",{id:"parameters-40"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"domNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-40"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,r.kt)("inlineCode",{parentName:"a"},"Colors"))),(0,r.kt)("p",null,"ColorBlockProps object"),(0,r.kt)("h4",{id:"defined-in-64"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/utils.ts#L62"},"packages/core/src/react/blocks/utils.ts:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getinlinestyles"},"getInlineStyles"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getInlineStyles"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Converts inline styles to a stylesObject for use in react components"),(0,r.kt)("h4",{id:"parameters-41"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"domNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-41"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-65"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/utils.ts#L120"},"packages/core/src/react/blocks/utils.ts:120")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"gettypographystyles"},"getTypographyStyles"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getTypographyStyles"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Returns the typography styles of a block"),(0,r.kt)("h4",{id:"parameters-42"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"domNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-42"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontSize")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"style")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"fontSize"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," = ''; ",(0,r.kt)("inlineCode",{parentName:"td"},"lineHeight"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," = '' }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"style.fontSize")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"style.lineHeight")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-66"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/utils.ts#L177"},"packages/core/src/react/blocks/utils.ts:177")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getwidthstyles"},"getWidthStyles"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getWidthStyles"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Returns the width size of a block"),(0,r.kt)("h4",{id:"parameters-43"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"domNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-43"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-67"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/utils.ts#L149"},"packages/core/src/react/blocks/utils.ts:149")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"parseseo"},"parseSeo"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"parseSeo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"seo"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Element"),"[]"),(0,r.kt)("h4",{id:"parameters-44"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"seo")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"HTMLReactParserOptions")))))),(0,r.kt)("h4",{id:"returns-44"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Element"),"[]"),(0,r.kt)("h4",{id:"defined-in-68"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/utils/parseSeo.ts#L4"},"packages/core/src/react/utils/parseSeo.ts:4")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"safearrayspread"},"safeArraySpread"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"safeArraySpread"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"array"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),"[]"),(0,r.kt)("h4",{id:"parameters-45"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"array")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"returns-45"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"any"),"[]"),(0,r.kt)("h4",{id:"defined-in-69"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/utils.ts#L220"},"packages/core/src/react/blocks/utils.ts:220")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"serializekey"},"serializeKey"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"serializeKey"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"parameters-46"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Key"))))),(0,r.kt)("h4",{id:"returns-46"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-70"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/core/dist/index.d.ts:17"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblock"},"useBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlock"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"node?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Returns the block name and attributes"),(0,r.kt)("h4",{id:"type-parameters-6"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,r.kt)("inlineCode",{parentName:"a"},"IBlockAttributes")))))),(0,r.kt)("h4",{id:"parameters-47"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-47"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"attributes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"className")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-71"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/hooks/useBlock.ts#L38"},"packages/core/src/react/blocks/hooks/useBlock.ts:38")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblockalign"},"useBlockAlign"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockAlign"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,r.kt)("inlineCode",{parentName:"a"},"Align"))),(0,r.kt)("p",null,"Returns the block align style (if available)"),(0,r.kt)("h4",{id:"parameters-48"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-48"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,r.kt)("inlineCode",{parentName:"a"},"Align"))),(0,r.kt)("h4",{id:"defined-in-72"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/hooks/useBlockAlign.ts#L16"},"packages/core/src/react/blocks/hooks/useBlockAlign.ts:16")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblockattributes"},"useBlockAttributes"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockAttributes"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"useBlockAttributes hooks returns the block attributes for a given block based on what it supports"),(0,r.kt)("h4",{id:"parameters-49"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The reference to the dom node of the block")))),(0,r.kt)("h4",{id:"returns-49"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"align")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,r.kt)("inlineCode",{parentName:"a"},"Align")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"blockStyle")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"border")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,r.kt)("inlineCode",{parentName:"a"},"Border")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"colors")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,r.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"spacing")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,r.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"typography")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,r.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"width")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-73"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/hooks/useBlockAttributes.ts#L19"},"packages/core/src/react/blocks/hooks/useBlockAttributes.ts:19")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblockborder"},"useBlockBorder"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockBorder"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,r.kt)("inlineCode",{parentName:"a"},"Border"))),(0,r.kt)("p",null,"Returns the block style (if available)"),(0,r.kt)("h4",{id:"parameters-50"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-50"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,r.kt)("inlineCode",{parentName:"a"},"Border"))),(0,r.kt)("h4",{id:"defined-in-74"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/hooks/useBlockBorder.ts#L17"},"packages/core/src/react/blocks/hooks/useBlockBorder.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblockcolors"},"useBlockColors"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockColors"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,r.kt)("inlineCode",{parentName:"a"},"Colors"))),(0,r.kt)("p",null,"Returns the block style (if available)"),(0,r.kt)("h4",{id:"parameters-51"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-51"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,r.kt)("inlineCode",{parentName:"a"},"Colors"))),(0,r.kt)("h4",{id:"defined-in-75"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/hooks/useBlockColors.ts#L25"},"packages/core/src/react/blocks/hooks/useBlockColors.ts:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblockspacing"},"useBlockSpacing"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockSpacing"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,r.kt)("inlineCode",{parentName:"a"},"Spacing"))),(0,r.kt)("p",null,"Returns the block style (if available)"),(0,r.kt)("h4",{id:"parameters-52"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-52"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,r.kt)("inlineCode",{parentName:"a"},"Spacing"))),(0,r.kt)("h4",{id:"defined-in-76"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/hooks/useBlockSpacing.ts#L21"},"packages/core/src/react/blocks/hooks/useBlockSpacing.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblockstyle"},"useBlockStyle"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockStyle"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Returns the block style (if available)"),(0,r.kt)("h4",{id:"parameters-53"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-53"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-77"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/hooks/useBlockStyle.ts#L10"},"packages/core/src/react/blocks/hooks/useBlockStyle.ts:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblocktypography"},"useBlockTypography"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockTypography"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,r.kt)("inlineCode",{parentName:"a"},"Typography"))),(0,r.kt)("p",null,"Returns the block style (if available)"),(0,r.kt)("h4",{id:"parameters-54"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-54"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,r.kt)("inlineCode",{parentName:"a"},"Typography"))),(0,r.kt)("h4",{id:"defined-in-78"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/hooks/useBlockTypography.ts#L25"},"packages/core/src/react/blocks/hooks/useBlockTypography.ts:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblockwidth"},"useBlockWidth"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockWidth"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Returns the block style (if available)"),(0,r.kt)("h4",{id:"parameters-55"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-55"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-79"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/hooks/useBlockWidth.ts#L16"},"packages/core/src/react/blocks/hooks/useBlockWidth.ts:16")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchauthorarchive"},"useFetchAuthorArchive"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchAuthorArchive"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useFetchAuthorArchive hook"),(0,r.kt)("p",null,"See useAuthorArchive"),(0,r.kt)("h4",{id:"type-parameters-7"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,r.kt)("h4",{id:"parameters-56"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The list of params to pass to the fetch strategy. It overrides the ones in the URL.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The options to pass to the swr hook.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path of the url to get url params from.")))),(0,r.kt)("h4",{id:"returns-56"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-80"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/useFetchAuthorArchive.ts#L22"},"packages/core/src/react/hooks/useFetchAuthorArchive.ts:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchpost"},"useFetchPost"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchPost"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"type-parameters-8"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostParams")))))),(0,r.kt)("h4",{id:"parameters-57"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''"))))),(0,r.kt)("h4",{id:"returns-57"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-81"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/useFetchPost.ts#L30"},"packages/core/src/react/hooks/useFetchPost.ts:30")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchpostorposts"},"useFetchPostOrPosts"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchPostOrPosts"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostOrPostResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"type-parameters-9"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostOrPostsParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostOrPostsParams")))))),(0,r.kt)("h4",{id:"parameters-58"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#postorpostsfetchstrategyresult"},(0,r.kt)("inlineCode",{parentName:"a"},"PostOrPostsFetchStrategyResult")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''"))))),(0,r.kt)("h4",{id:"returns-58"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostOrPostResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-82"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/useFetchPostOrPosts.ts#L32"},"packages/core/src/react/hooks/useFetchPostOrPosts.ts:32")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useswr"},"useSWR"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRKey"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-10"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Key")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"StrictKey"))))),(0,r.kt)("h4",{id:"parameters-59"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"))))),(0,r.kt)("h4",{id:"returns-59"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-83"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:200"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRKey"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fetcher"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-11"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Key")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"StrictKey"))))),(0,r.kt)("h4",{id:"parameters-60"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetcher")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Fetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"),">")))),(0,r.kt)("h4",{id:"returns-60"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-84"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:201"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRKey"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"config"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-12"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Key")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"StrictKey"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Fetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"),">",">",">"," = ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Fetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"),">",">",">")))),(0,r.kt)("h4",{id:"parameters-61"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"config")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions"))))),(0,r.kt)("h4",{id:"returns-61"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("h4",{id:"defined-in-85"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:202"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRKey"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fetcher"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"config"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-13"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Key")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"StrictKey"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Fetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"),">",">",">"," = ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Fetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"),">",">",">")))),(0,r.kt)("h4",{id:"parameters-62"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetcher")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Fetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"config")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions"))))),(0,r.kt)("h4",{id:"returns-62"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("h4",{id:"defined-in-86"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:203"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-14"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"parameters-63"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Key"))))),(0,r.kt)("h4",{id:"returns-63"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-87"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:204"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fetcher"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-15"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"parameters-64"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Key"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetcher")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),">")))),(0,r.kt)("h4",{id:"returns-64"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-88"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:205"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"config"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-16"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),">",">",">"," = ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),">",">",">")))),(0,r.kt)("h4",{id:"parameters-65"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Key"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"config")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions"))))),(0,r.kt)("h4",{id:"returns-65"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("h4",{id:"defined-in-89"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:206"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fetcher"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"config"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-17"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),">",">",">"," = ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),">",">",">")))),(0,r.kt)("h4",{id:"parameters-66"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Key"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetcher")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"config")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions"))))),(0,r.kt)("h4",{id:"returns-66"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("h4",{id:"defined-in-90"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:207"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useswrconfig"},"useSWRConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWRConfig"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"FullConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">",">"),(0,r.kt)("h4",{id:"returns-67"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"FullConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">",">"),(0,r.kt)("h4",{id:"defined-in-91"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:336"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usesettings"},"useSettings"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSettings"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingscontextprops"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsContextProps")),">"),(0,r.kt)("h4",{id:"returns-68"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingscontextprops"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsContextProps")),">"),(0,r.kt)("h4",{id:"defined-in-92"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/useSettings.ts#L4"},"packages/core/src/react/provider/useSettings.ts:4")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usethemesetting"},"useThemeSetting"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useThemeSetting"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"blockName?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"defaultValue?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fallbackToGlobalSetting?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("p",null,"Returns a single theme setting normalized"),(0,r.kt)("h4",{id:"parameters-67"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path to the setting")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"blockName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The block name")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"defaultValue")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the default value to return")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fallbackToGlobalSetting")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"true")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Whether it should fallback to global setting if blockName is passed but setting does not exist")))),(0,r.kt)("h4",{id:"returns-69"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h4",{id:"defined-in-93"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/useThemeSetting.ts#L22"},"packages/core/src/react/provider/useThemeSetting.ts:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usethemesettings"},"useThemeSettings"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useThemeSettings"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"blocks?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"core/archives?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/audio?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/block?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/button?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/buttons?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/calendar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/categories?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/code?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/column?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-avatar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-name?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-edit-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-reply-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comments-query-loop?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/cover?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/embed?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/file?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/freeform?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/gallery?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/heading?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/home-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/html?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-posts?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/legacy-widget?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/loginout?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/media-text?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/missing?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/more?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/nextpage?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/page-list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/paragraph?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-author?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-count?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-form?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-excerpt?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-featured-image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-terms?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/preformatted?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/pullquote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-next?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-numbers?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-previous?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/quote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/rss?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/search?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/separator?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/shortcode?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-logo?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-tagline?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-links?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/spacer?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table-of-contents?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/tag-cloud?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/template-part?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/term-description?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/text-columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/verse?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/video?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-area?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"border?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"radius?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"style?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"width?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"background?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"custom?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"customDuotone?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"customGradient?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"defaultGradients?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"defaultPalette?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"duotone?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingsduotone"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsDuotone"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"gradients?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingsgradient"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsGradient"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"link?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"palette?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingscolorpalette"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsColorPalette"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"text?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"custom?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"[k: string]"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsCustomAdditionalProperties")),"; } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"layout?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"contentSize?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"wideSize?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"spacing?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"blockGap?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"margin?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"padding?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"units?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[] } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"typography?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"customFontSize?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"dropCap?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontFamilies?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"fontFamily?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"name?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"slug?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontSizes?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"name?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"size?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"slug?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontStyle?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontWeight?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"letterSpacing?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"lineHeight?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"textDecoration?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"textTransform?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } }"),(0,r.kt)("p",null,"Returns the raw theme.json settings definitions"),(0,r.kt)("h4",{id:"returns-70"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"blocks?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"core/archives?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/audio?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/block?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/button?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/buttons?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/calendar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/categories?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/code?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/column?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-avatar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-name?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-edit-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-reply-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comments-query-loop?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/cover?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/embed?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/file?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/freeform?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/gallery?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/heading?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/home-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/html?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-posts?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/legacy-widget?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/loginout?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/media-text?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/missing?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/more?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/nextpage?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/page-list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/paragraph?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-author?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-count?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-form?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-excerpt?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-featured-image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-terms?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/preformatted?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/pullquote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-next?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-numbers?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-previous?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/quote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/rss?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/search?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/separator?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/shortcode?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-logo?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-tagline?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-links?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/spacer?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table-of-contents?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/tag-cloud?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/template-part?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/term-description?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/text-columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/verse?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/video?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-area?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"border?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"radius?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"style?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"width?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"background?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"custom?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"customDuotone?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"customGradient?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"defaultGradients?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"defaultPalette?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"duotone?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingsduotone"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsDuotone"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"gradients?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingsgradient"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsGradient"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"link?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"palette?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingscolorpalette"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsColorPalette"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"text?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"custom?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"[k: string]"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsCustomAdditionalProperties")),"; } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"layout?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"contentSize?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"wideSize?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"spacing?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"blockGap?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"margin?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"padding?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"units?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[] } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"typography?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"customFontSize?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"dropCap?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontFamilies?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"fontFamily?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"name?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"slug?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontSizes?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"name?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"size?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"slug?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontStyle?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontWeight?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"letterSpacing?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"lineHeight?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"textDecoration?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"textTransform?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } }"),(0,r.kt)("h4",{id:"defined-in-94"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/useThemeSettings.ts#L9"},"packages/core/src/react/provider/useThemeSettings.ts:9")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usethemestyles"},"useThemeStyles"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useThemeStyles"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesProperties"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"blocks?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"core/archives?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/audio?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/block?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/button?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/buttons?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/calendar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/categories?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/code?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/column?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-avatar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-name?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-edit-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-reply-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comments-query-loop?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/cover?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/embed?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/file?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/freeform?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/gallery?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/heading?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/home-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/html?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-posts?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/legacy-widget?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/loginout?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/media-text?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/missing?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/more?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/nextpage?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/page-list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/paragraph?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-author?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-count?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-form?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-excerpt?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-featured-image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-terms?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/preformatted?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/pullquote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-next?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-numbers?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-previous?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/quote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/rss?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/search?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/separator?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/shortcode?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-logo?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-tagline?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-links?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/spacer?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table-of-contents?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/tag-cloud?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/template-part?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/term-description?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/text-columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/verse?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/video?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-area?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"border?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"elements?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"h1?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h2?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h3?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h4?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h5?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h6?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"spacing?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"typography?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," }"),(0,r.kt)("p",null,"Returns the theme.json styles definitions"),(0,r.kt)("h4",{id:"returns-71"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesProperties"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"blocks?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"core/archives?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/audio?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/block?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/button?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/buttons?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/calendar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/categories?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/code?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/column?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-avatar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-name?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-edit-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-reply-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comments-query-loop?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/cover?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/embed?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/file?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/freeform?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/gallery?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/heading?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/home-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/html?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-posts?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/legacy-widget?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/loginout?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/media-text?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/missing?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/more?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/nextpage?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/page-list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/paragraph?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-author?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-count?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-form?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-excerpt?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-featured-image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-terms?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/preformatted?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/pullquote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-next?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-numbers?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-previous?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/quote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/rss?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/search?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/separator?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/shortcode?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-logo?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-tagline?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-links?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/spacer?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table-of-contents?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/tag-cloud?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/template-part?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/term-description?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/text-columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/verse?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/video?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-area?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"border?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"elements?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"h1?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h2?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h3?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h4?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h5?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h6?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"spacing?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"typography?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," }"),(0,r.kt)("h4",{id:"defined-in-95"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/useThemeStyles.ts#L9"},"packages/core/src/react/provider/useThemeStyles.ts:9")),(0,r.kt)("h2",{id:"react-components"},"React Components"),(0,r.kt)("h3",{id:"blocksrenderer"},"BlocksRenderer"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"BlocksRenderer"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"BlocksRenderer")," components provides an easy way to convert HTML markup into corresponding\nReact components."),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"BlocksRenderer")," component takes in arbitrary html markup and receives a list of react components\nas children that allows replacing dom nodes with React Components."),(0,r.kt)("p",null,"The html prop is sanitized through ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#wpksespost"},"wpKsesPost")," so it's safe for rendering arbitrary html markup."),(0,r.kt)("p",null,"The children components must implement the ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.BlockProps"},"BlockProps")," interface"),(0,r.kt)("h4",{id:"usage-1"},"Usage"),(0,r.kt)("h5",{id:"usage-with-the-test-function"},"Usage with the test function"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"\n isAnchorTag(node, { isInternalLink: true })} />\n\n")),(0,r.kt)("h5",{id:"usage-with-classlist-and-tagname-props"},"Usage with classList and tagName props"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},'\n \n\n')),(0,r.kt)("h4",{id:"parameters-68"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.BlockRendererProps"},(0,r.kt)("inlineCode",{parentName:"a"},"BlockRendererProps"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component properties")))),(0,r.kt)("h4",{id:"returns-72"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-96"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L165"},"packages/core/src/react/components/BlocksRenderer.tsx:165")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"htmldecoder"},"HtmlDecoder"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"HtmlDecoder"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"context?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"HtmlDecoder")," simply decodes html entities"),(0,r.kt)("p",null,"Any actual html markup gets stripped before decoding html entities. If you need to render HTML use ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#safehtml"},"SafeHtml")),(0,r.kt)("h4",{id:"usage-2"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},'\n')),(0,r.kt)("h4",{id:"parameters-69"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"PropsWithChildren"),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.HtmlDecodeProps"},(0,r.kt)("inlineCode",{parentName:"a"},"HtmlDecodeProps")),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component properties")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"context?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-73"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-97"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/react/index.d.ts:542"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"safehtml"},"SafeHtml"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"SafeHtml"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"context?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"SafeHtml")," component provides an easy way to safely render HTML"),(0,r.kt)("p",null,"The html prop is sanitized through ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#wpksespost"},"wpKsesPost")," so it's safe for rendering arbitrary html markup."),(0,r.kt)("h4",{id:"usage-3"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},'\n')),(0,r.kt)("h4",{id:"parameters-70"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"PropsWithChildren"),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.SafeHtmlProps"},(0,r.kt)("inlineCode",{parentName:"a"},"SafeHtmlProps")),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component properties")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"context?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-74"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-98"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/react/index.d.ts:542"))}m.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2398],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>N});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function p(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var o=n.createContext({}),s=function(e){var t=n.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=s(e.components);return n.createElement(o.Provider,{value:t},e.children)},m="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},c=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,p=e.originalType,o=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),m=s(a),c=r,N=m["".concat(o,".").concat(c)]||m[c]||k[c]||p;return a?n.createElement(N,i(i({ref:t},d),{},{components:a})):n.createElement(N,i({ref:t},d))}));function N(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var p=a.length,i=new Array(p);i[0]=c;var l={};for(var o in t)hasOwnProperty.call(t,o)&&(l[o]=t[o]);l.originalType=e,l[m]="string"==typeof e?e:r,i[1]=l;for(var s=2;s{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>i,default:()=>m,frontMatter:()=>p,metadata:()=>l,toc:()=>s});var n=a(7462),r=(a(7294),a(3905));const p={id:"headstartwp_core.react",title:"Namespace: react",sidebar_label:"@headstartwp/core.react",custom_edit_url:null},i=void 0,l={unversionedId:"namespaces/headstartwp_core.react",id:"namespaces/headstartwp_core.react",title:"Namespace: react",description:"@headstartwp/core.react",source:"@site/docs/namespaces/headstartwp_core.react.md",sourceDirName:"namespaces",slug:"/namespaces/headstartwp_core.react",permalink:"/docs/api/namespaces/headstartwp_core.react",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react",title:"Namespace: react",sidebar_label:"@headstartwp/core.react",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/next",permalink:"/docs/api/modules/headstartwp_next"},next:{title:"@headstartwp/next.config",permalink:"/docs/api/namespaces/headstartwp_next.config"}},o={},s=[{value:"@headstartwp/core/react",id:"headstartwpcorereact",level:2},{value:"Usage",id:"usage",level:3},{value:"Interfaces",id:"interfaces",level:2},{value:"Blocks",id:"blocks",level:2},{value:"AudioBlock",id:"audioblock",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"ButtonBlock",id:"buttonblock",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"ButtonsBlock",id:"buttonsblock",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"CodeBlock",id:"codeblock",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Data Fetching Hooks",id:"data-fetching-hooks",level:2},{value:"useFetch",id:"usefetch",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"useFetchAppSettings",id:"usefetchappsettings",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"useFetchMenu",id:"usefetchmenu",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"useFetchPosts",id:"usefetchposts",level:3},{value:"Type parameters",id:"type-parameters-2",level:4},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"useFetchSearch",id:"usefetchsearch",level:3},{value:"Type parameters",id:"type-parameters-3",level:4},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"useFetchSearchNative",id:"usefetchsearchnative",level:3},{value:"Type parameters",id:"type-parameters-4",level:4},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"useFetchTerms",id:"usefetchterms",level:3},{value:"Type parameters",id:"type-parameters-5",level:4},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"Other",id:"other",level:2},{value:"Align",id:"align",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"Border",id:"border",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"DataFetchingProviderProps",id:"datafetchingproviderprops",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"ItemWrapper",id:"itemwrapper",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Parameters",id:"parameters-11",level:5},{value:"Returns",id:"returns-11",level:5},{value:"Defined in",id:"defined-in-14",level:4},{value:"ItemWrapperProps",id:"itemwrapperprops",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"LinkWrapper",id:"linkwrapper",level:3},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Parameters",id:"parameters-12",level:5},{value:"Returns",id:"returns-12",level:5},{value:"Defined in",id:"defined-in-16",level:4},{value:"LinkWrapperProps",id:"linkwrapperprops",level:3},{value:"Defined in",id:"defined-in-17",level:4},{value:"MenuItemsProp",id:"menuitemsprop",level:3},{value:"Type declaration",id:"type-declaration-4",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"MenuWrapper",id:"menuwrapper",level:3},{value:"Type declaration",id:"type-declaration-5",level:4},{value:"Parameters",id:"parameters-13",level:5},{value:"Returns",id:"returns-13",level:5},{value:"Defined in",id:"defined-in-19",level:4},{value:"MenuWrapperProps",id:"menuwrapperprops",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"PageType",id:"pagetype",level:3},{value:"Type declaration",id:"type-declaration-6",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"SettingsColorPalette",id:"settingscolorpalette",level:3},{value:"Type declaration",id:"type-declaration-7",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"SettingsColorPreset",id:"settingscolorpreset",level:3},{value:"Type declaration",id:"type-declaration-8",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"SettingsContextProps",id:"settingscontextprops",level:3},{value:"Defined in",id:"defined-in-24",level:4},{value:"SettingsDuotone",id:"settingsduotone",level:3},{value:"Type declaration",id:"type-declaration-9",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"SettingsDuotonePreset",id:"settingsduotonepreset",level:3},{value:"Type declaration",id:"type-declaration-10",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"SettingsGradient",id:"settingsgradient",level:3},{value:"Type declaration",id:"type-declaration-11",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"SettingsGradientPreset",id:"settingsgradientpreset",level:3},{value:"Type declaration",id:"type-declaration-12",level:4},{value:"Defined in",id:"defined-in-28",level:4},{value:"SettingsPropertiesComplete",id:"settingspropertiescomplete",level:3},{value:"Defined in",id:"defined-in-29",level:4},{value:"Spacing",id:"spacing",level:3},{value:"Type declaration",id:"type-declaration-13",level:4},{value:"Defined in",id:"defined-in-30",level:4},{value:"Style",id:"style",level:3},{value:"Type declaration",id:"type-declaration-14",level:4},{value:"Defined in",id:"defined-in-31",level:4},{value:"StylesPropertiesAndElementsComplete",id:"stylespropertiesandelementscomplete",level:3},{value:"Defined in",id:"defined-in-32",level:4},{value:"StylesPropertiesComplete",id:"stylespropertiescomplete",level:3},{value:"Defined in",id:"defined-in-33",level:4},{value:"ThemeJSON",id:"themejson",level:3},{value:"Defined in",id:"defined-in-34",level:4},{value:"SettingsContext",id:"settingscontext",level:3},{value:"Defined in",id:"defined-in-35",level:4},{value:"ThemeSettingsContext",id:"themesettingscontext",level:3},{value:"Defined in",id:"defined-in-36",level:4},{value:"defaultElement",id:"defaultelement",level:3},{value:"Defined in",id:"defined-in-37",level:4},{value:"ColumnBlock",id:"columnblock",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-38",level:4},{value:"ColumnsBlock",id:"columnsblock",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-39",level:4},{value:"CoverBlock",id:"coverblock",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-40",level:4},{value:"DataFetchingProvider",id:"datafetchingprovider",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-41",level:4},{value:"DebugBlock",id:"debugblock",level:3},{value:"Parameters",id:"parameters-18",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Defined in",id:"defined-in-42",level:4},{value:"FileBlock",id:"fileblock",level:3},{value:"Parameters",id:"parameters-19",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Defined in",id:"defined-in-43",level:4},{value:"GroupBlock",id:"groupblock",level:3},{value:"Parameters",id:"parameters-20",level:4},{value:"Returns",id:"returns-20",level:4},{value:"Defined in",id:"defined-in-44",level:4},{value:"HeadingBlock",id:"headingblock",level:3},{value:"Parameters",id:"parameters-21",level:4},{value:"Returns",id:"returns-21",level:4},{value:"Defined in",id:"defined-in-45",level:4},{value:"ImageBlock",id:"imageblock",level:3},{value:"Parameters",id:"parameters-22",level:4},{value:"Returns",id:"returns-22",level:4},{value:"Defined in",id:"defined-in-46",level:4},{value:"ListBlock",id:"listblock",level:3},{value:"Parameters",id:"parameters-23",level:4},{value:"Returns",id:"returns-23",level:4},{value:"Defined in",id:"defined-in-47",level:4},{value:"MediaTextBlock",id:"mediatextblock",level:3},{value:"Parameters",id:"parameters-24",level:4},{value:"Returns",id:"returns-24",level:4},{value:"Defined in",id:"defined-in-48",level:4},{value:"Menu",id:"menu",level:3},{value:"Parameters",id:"parameters-25",level:4},{value:"Returns",id:"returns-25",level:4},{value:"Defined in",id:"defined-in-49",level:4},{value:"MenuItems",id:"menuitems",level:3},{value:"Parameters",id:"parameters-26",level:4},{value:"Returns",id:"returns-26",level:4},{value:"Defined in",id:"defined-in-50",level:4},{value:"ParagraphBlock",id:"paragraphblock",level:3},{value:"Parameters",id:"parameters-27",level:4},{value:"Returns",id:"returns-27",level:4},{value:"Defined in",id:"defined-in-51",level:4},{value:"PreformattedBlock",id:"preformattedblock",level:3},{value:"Parameters",id:"parameters-28",level:4},{value:"Returns",id:"returns-28",level:4},{value:"Defined in",id:"defined-in-52",level:4},{value:"PullQuoteBlock",id:"pullquoteblock",level:3},{value:"Parameters",id:"parameters-29",level:4},{value:"Returns",id:"returns-29",level:4},{value:"Defined in",id:"defined-in-53",level:4},{value:"QuoteBlock",id:"quoteblock",level:3},{value:"Parameters",id:"parameters-30",level:4},{value:"Returns",id:"returns-30",level:4},{value:"Defined in",id:"defined-in-54",level:4},{value:"SeparatorBlock",id:"separatorblock",level:3},{value:"Parameters",id:"parameters-31",level:4},{value:"Returns",id:"returns-31",level:4},{value:"Defined in",id:"defined-in-55",level:4},{value:"SettingsProvider",id:"settingsprovider",level:3},{value:"Parameters",id:"parameters-32",level:4},{value:"Returns",id:"returns-32",level:4},{value:"Defined in",id:"defined-in-56",level:4},{value:"SpacerBlock",id:"spacerblock",level:3},{value:"Parameters",id:"parameters-33",level:4},{value:"Returns",id:"returns-33",level:4},{value:"Defined in",id:"defined-in-57",level:4},{value:"TableBlock",id:"tableblock",level:3},{value:"Parameters",id:"parameters-34",level:4},{value:"Returns",id:"returns-34",level:4},{value:"Defined in",id:"defined-in-58",level:4},{value:"ThemeSettingsProvider",id:"themesettingsprovider",level:3},{value:"Parameters",id:"parameters-35",level:4},{value:"Returns",id:"returns-35",level:4},{value:"Defined in",id:"defined-in-59",level:4},{value:"VerseBlock",id:"verseblock",level:3},{value:"Parameters",id:"parameters-36",level:4},{value:"Returns",id:"returns-36",level:4},{value:"Defined in",id:"defined-in-60",level:4},{value:"YoutubeLiteBlock",id:"youtubeliteblock",level:3},{value:"Parameters",id:"parameters-37",level:4},{value:"Returns",id:"returns-37",level:4},{value:"Defined in",id:"defined-in-61",level:4},{value:"getAlignStyle",id:"getalignstyle",level:3},{value:"Parameters",id:"parameters-38",level:4},{value:"Returns",id:"returns-38",level:4},{value:"Defined in",id:"defined-in-62",level:4},{value:"getBlockStyle",id:"getblockstyle",level:3},{value:"Parameters",id:"parameters-39",level:4},{value:"Returns",id:"returns-39",level:4},{value:"Defined in",id:"defined-in-63",level:4},{value:"getColorStyles",id:"getcolorstyles",level:3},{value:"Parameters",id:"parameters-40",level:4},{value:"Returns",id:"returns-40",level:4},{value:"Defined in",id:"defined-in-64",level:4},{value:"getInlineStyles",id:"getinlinestyles",level:3},{value:"Parameters",id:"parameters-41",level:4},{value:"Returns",id:"returns-41",level:4},{value:"Defined in",id:"defined-in-65",level:4},{value:"getTypographyStyles",id:"gettypographystyles",level:3},{value:"Parameters",id:"parameters-42",level:4},{value:"Returns",id:"returns-42",level:4},{value:"Defined in",id:"defined-in-66",level:4},{value:"getWidthStyles",id:"getwidthstyles",level:3},{value:"Parameters",id:"parameters-43",level:4},{value:"Returns",id:"returns-43",level:4},{value:"Defined in",id:"defined-in-67",level:4},{value:"parseSeo",id:"parseseo",level:3},{value:"Parameters",id:"parameters-44",level:4},{value:"Returns",id:"returns-44",level:4},{value:"Defined in",id:"defined-in-68",level:4},{value:"safeArraySpread",id:"safearrayspread",level:3},{value:"Parameters",id:"parameters-45",level:4},{value:"Returns",id:"returns-45",level:4},{value:"Defined in",id:"defined-in-69",level:4},{value:"serializeKey",id:"serializekey",level:3},{value:"Parameters",id:"parameters-46",level:4},{value:"Returns",id:"returns-46",level:4},{value:"Defined in",id:"defined-in-70",level:4},{value:"useBlock",id:"useblock",level:3},{value:"Type parameters",id:"type-parameters-6",level:4},{value:"Parameters",id:"parameters-47",level:4},{value:"Returns",id:"returns-47",level:4},{value:"Defined in",id:"defined-in-71",level:4},{value:"useBlockAlign",id:"useblockalign",level:3},{value:"Parameters",id:"parameters-48",level:4},{value:"Returns",id:"returns-48",level:4},{value:"Defined in",id:"defined-in-72",level:4},{value:"useBlockAttributes",id:"useblockattributes",level:3},{value:"Parameters",id:"parameters-49",level:4},{value:"Returns",id:"returns-49",level:4},{value:"Defined in",id:"defined-in-73",level:4},{value:"useBlockBorder",id:"useblockborder",level:3},{value:"Parameters",id:"parameters-50",level:4},{value:"Returns",id:"returns-50",level:4},{value:"Defined in",id:"defined-in-74",level:4},{value:"useBlockColors",id:"useblockcolors",level:3},{value:"Parameters",id:"parameters-51",level:4},{value:"Returns",id:"returns-51",level:4},{value:"Defined in",id:"defined-in-75",level:4},{value:"useBlockSpacing",id:"useblockspacing",level:3},{value:"Parameters",id:"parameters-52",level:4},{value:"Returns",id:"returns-52",level:4},{value:"Defined in",id:"defined-in-76",level:4},{value:"useBlockStyle",id:"useblockstyle",level:3},{value:"Parameters",id:"parameters-53",level:4},{value:"Returns",id:"returns-53",level:4},{value:"Defined in",id:"defined-in-77",level:4},{value:"useBlockTypography",id:"useblocktypography",level:3},{value:"Parameters",id:"parameters-54",level:4},{value:"Returns",id:"returns-54",level:4},{value:"Defined in",id:"defined-in-78",level:4},{value:"useBlockWidth",id:"useblockwidth",level:3},{value:"Parameters",id:"parameters-55",level:4},{value:"Returns",id:"returns-55",level:4},{value:"Defined in",id:"defined-in-79",level:4},{value:"useFetchAuthorArchive",id:"usefetchauthorarchive",level:3},{value:"Type parameters",id:"type-parameters-7",level:4},{value:"Parameters",id:"parameters-56",level:4},{value:"Returns",id:"returns-56",level:4},{value:"Defined in",id:"defined-in-80",level:4},{value:"useFetchPost",id:"usefetchpost",level:3},{value:"Type parameters",id:"type-parameters-8",level:4},{value:"Parameters",id:"parameters-57",level:4},{value:"Returns",id:"returns-57",level:4},{value:"Defined in",id:"defined-in-81",level:4},{value:"useFetchPostOrPosts",id:"usefetchpostorposts",level:3},{value:"Type parameters",id:"type-parameters-9",level:4},{value:"Parameters",id:"parameters-58",level:4},{value:"Returns",id:"returns-58",level:4},{value:"Defined in",id:"defined-in-82",level:4},{value:"useSWR",id:"useswr",level:3},{value:"Type parameters",id:"type-parameters-10",level:4},{value:"Parameters",id:"parameters-59",level:4},{value:"Returns",id:"returns-59",level:4},{value:"Defined in",id:"defined-in-83",level:4},{value:"Type parameters",id:"type-parameters-11",level:4},{value:"Parameters",id:"parameters-60",level:4},{value:"Returns",id:"returns-60",level:4},{value:"Defined in",id:"defined-in-84",level:4},{value:"Type parameters",id:"type-parameters-12",level:4},{value:"Parameters",id:"parameters-61",level:4},{value:"Returns",id:"returns-61",level:4},{value:"Defined in",id:"defined-in-85",level:4},{value:"Type parameters",id:"type-parameters-13",level:4},{value:"Parameters",id:"parameters-62",level:4},{value:"Returns",id:"returns-62",level:4},{value:"Defined in",id:"defined-in-86",level:4},{value:"Type parameters",id:"type-parameters-14",level:4},{value:"Parameters",id:"parameters-63",level:4},{value:"Returns",id:"returns-63",level:4},{value:"Defined in",id:"defined-in-87",level:4},{value:"Type parameters",id:"type-parameters-15",level:4},{value:"Parameters",id:"parameters-64",level:4},{value:"Returns",id:"returns-64",level:4},{value:"Defined in",id:"defined-in-88",level:4},{value:"Type parameters",id:"type-parameters-16",level:4},{value:"Parameters",id:"parameters-65",level:4},{value:"Returns",id:"returns-65",level:4},{value:"Defined in",id:"defined-in-89",level:4},{value:"Type parameters",id:"type-parameters-17",level:4},{value:"Parameters",id:"parameters-66",level:4},{value:"Returns",id:"returns-66",level:4},{value:"Defined in",id:"defined-in-90",level:4},{value:"useSWRConfig",id:"useswrconfig",level:3},{value:"Returns",id:"returns-67",level:4},{value:"Defined in",id:"defined-in-91",level:4},{value:"useSettings",id:"usesettings",level:3},{value:"Returns",id:"returns-68",level:4},{value:"Defined in",id:"defined-in-92",level:4},{value:"useThemeSetting",id:"usethemesetting",level:3},{value:"Parameters",id:"parameters-67",level:4},{value:"Returns",id:"returns-69",level:4},{value:"Defined in",id:"defined-in-93",level:4},{value:"useThemeSettings",id:"usethemesettings",level:3},{value:"Returns",id:"returns-70",level:4},{value:"Defined in",id:"defined-in-94",level:4},{value:"useThemeStyles",id:"usethemestyles",level:3},{value:"Returns",id:"returns-71",level:4},{value:"Defined in",id:"defined-in-95",level:4},{value:"React Components",id:"react-components",level:2},{value:"BlocksRenderer",id:"blocksrenderer",level:3},{value:"Usage",id:"usage-1",level:4},{value:"Usage with the test function",id:"usage-with-the-test-function",level:5},{value:"Usage with classList and tagName props",id:"usage-with-classlist-and-tagname-props",level:5},{value:"Parameters",id:"parameters-68",level:4},{value:"Returns",id:"returns-72",level:4},{value:"Defined in",id:"defined-in-96",level:4},{value:"HtmlDecoder",id:"htmldecoder",level:3},{value:"Usage",id:"usage-2",level:4},{value:"Parameters",id:"parameters-69",level:4},{value:"Returns",id:"returns-73",level:4},{value:"Defined in",id:"defined-in-97",level:4},{value:"SafeHtml",id:"safehtml",level:3},{value:"Usage",id:"usage-3",level:4},{value:"Parameters",id:"parameters-70",level:4},{value:"Returns",id:"returns-74",level:4},{value:"Defined in",id:"defined-in-98",level:4}],d={toc:s};function m(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".react"),(0,r.kt)("h2",{id:"headstartwpcorereact"},"@headstartwp/core/react"),(0,r.kt)("p",null,"The react export of the ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/core")," package."),(0,r.kt)("h3",{id:"usage"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},'import { BlocksRenderer } from "@headstartwp/core/react";\n')),(0,r.kt)("h2",{id:"interfaces"},"Interfaces"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps"},"AudioBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.BlockAttributes"},"BlockAttributes")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.BlockProps"},"BlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.BlockRendererProps"},"BlockRendererProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps"},"ButtonBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps"},"ButtonsBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps"},"CodeBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps"},"ColumnBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps"},"ColumnsBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps"},"CoverBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},"FetchHookOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps"},"FileBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps"},"GroupBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.GutenbergBlockProps"},"GutenbergBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps"},"HeadingBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.HtmlDecodeProps"},"HtmlDecodeProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IAudioBlock"},"IAudioBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IButtonBlock"},"IButtonBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IButtonsBlock"},"IButtonsBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ICodeBlock"},"ICodeBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IColumnBlock"},"IColumnBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IColumnsBlock"},"IColumnsBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ICoverBlock"},"ICoverBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IDataWPBlock"},"IDataWPBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IFileBlock"},"IFileBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IGroupBlock"},"IGroupBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IHeadingBlock"},"IHeadingBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IImageBlock"},"IImageBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IListBlock"},"IListBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IMediaTextBlock"},"IMediaTextBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IParagraphBlock"},"IParagraphBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IPreformattedBlock"},"IPreformattedBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IPullQuoteBlock"},"IPullQuoteBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IQuoteBlock"},"IQuoteBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ISeparatorBlock"},"ISeparatorBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ISpacerBlock"},"ISpacerBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ITableBlock"},"ITableBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IVerseBlock"},"IVerseBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock"},"IYoutubeLiteBlock")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps"},"ImageBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps"},"ListBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps"},"MediaTextBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps"},"ParagraphBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps"},"PreformattedBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps"},"PullQuoteBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps"},"QuoteBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.SafeHtmlProps"},"SafeHtmlProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps"},"SeparatorBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties"},"SettingsCustomAdditionalProperties")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},"SettingsProperties")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps"},"SpacerBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete"},"StylesElementsPropertiesComplete")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"},"StylesProperties")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps"},"TableBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},"Typography")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps"},"VerseBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.WpThemeJSON"},"WpThemeJSON")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps"},"YoutubeLiteBlockProps")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse"},"useAppSettingsResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.useFetchOptions"},"useFetchOptions")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse"},"useMenuResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse"},"usePostOrPostResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.usePostResponse"},"usePostResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"},"usePostsResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.useSearchNativeResponse"},"useSearchNativeResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse"},"useSearchResponse")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse"},"useTermsResponse"))),(0,r.kt)("h2",{id:"blocks"},"Blocks"),(0,r.kt)("h3",{id:"audioblock"},"AudioBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"AudioBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The AudioBlock components implements block parsing for the Audio block."),(0,r.kt)("p",null,"This component must be used within a ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#blocksrenderer"},"BlocksRenderer")," component."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"\n \n\n")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IAudioBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IAudioBlock"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component properties")))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/AudioBlock.tsx#L58"},"packages/core/src/react/blocks/AudioBlock.tsx:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"buttonblock"},"ButtonBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ButtonBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The ButtonBlock component implements block parsing for the Button block."),(0,r.kt)("p",null,"This component must be used within a ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#blocksrenderer"},"BlocksRenderer")," component."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"\n \n\n")),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IButtonBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IButtonBlock"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component properties")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/ButtonBlock.tsx#L62"},"packages/core/src/react/blocks/ButtonBlock.tsx:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"buttonsblock"},"ButtonsBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ButtonsBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The ButtonsBlock component implements block parsing for the Buttons block."),(0,r.kt)("p",null,"This component must be used within a ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#blocksrenderer"},"BlocksRenderer")," component."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"\n \n\n")),(0,r.kt)("h4",{id:"parameters-2"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IButtonsBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IButtonsBlock"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component properties")))),(0,r.kt)("h4",{id:"returns-2"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/ButtonsBlock.tsx#L28"},"packages/core/src/react/blocks/ButtonsBlock.tsx:28")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"codeblock"},"CodeBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"CodeBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The CodeBlock component implements block parsing for the core/code block."),(0,r.kt)("p",null,"This component must be used within a ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#blocksrenderer"},"BlocksRenderer")," component."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"\n \n\n")),(0,r.kt)("h4",{id:"parameters-3"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ICodeBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"ICodeBlock"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component properties")))),(0,r.kt)("h4",{id:"returns-3"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/CodeBlock.tsx#L32"},"packages/core/src/react/blocks/CodeBlock.tsx:32")),(0,r.kt)("h2",{id:"data-fetching-hooks"},"Data Fetching Hooks"),(0,r.kt)("h3",{id:"usefetch"},"useFetch"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetch"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"E"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Params"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"R"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fetchStrategy"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"The use Fetch Hook is the foundation for most hooks in the headless framework. It is a wrapper around\n",(0,r.kt)("inlineCode",{parentName:"p"},"useSWR")," and provides a consistent API for fetching data from the API. It requires a fetch strategy which implements\nthe actual data fetching logic"),(0,r.kt)("h4",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"E")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"E"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,r.kt)("inlineCode",{parentName:"a"},"EndpointParams")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"R")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"E"))))),(0,r.kt)("h4",{id:"parameters-4"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The list of params to pass to the fetch strategy. It overrides the ones in the URL.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetchStrategy")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,r.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"E"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Params"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The fetch strategy.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"R"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The options to pass to the swr hook.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path of the url to get url params from.")))),(0,r.kt)("h4",{id:"returns-4"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The returned data of the fetcher function.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The error object thrown by the fetcher function.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isLoading")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isMainQuery")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isValidating")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"mutate")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"KeyedMutator"),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"R"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetch.ts#L30"},"packages/core/src/react/hooks/useFetch.ts:30")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchappsettings"},"useFetchAppSettings"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchAppSettings"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useAppSettingsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useAppSettings hook"),(0,r.kt)("p",null,"See useAppSettings"),(0,r.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AppEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AppEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,r.kt)("inlineCode",{parentName:"a"},"EndpointParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,r.kt)("inlineCode",{parentName:"a"},"EndpointParams")))))),(0,r.kt)("h4",{id:"parameters-5"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The list of params to pass to the fetch strategy. It overrides the ones in the URL.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The options to pass to the swr hook.")))),(0,r.kt)("h4",{id:"returns-5"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useAppSettingsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetchAppSettings.ts#L23"},"packages/core/src/react/hooks/useFetchAppSettings.ts:23")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchmenu"},"useFetchMenu"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchMenu"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"menuLocation"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useMenuResponse"))),(0,r.kt)("p",null,"The useFetchMenu hooks. Returns a Menu object."),(0,r.kt)("h4",{id:"parameters-6"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"menuLocation")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The slug of the menu location you want to fetch")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AppEntity")),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"SWR configuration options")))),(0,r.kt)("h4",{id:"returns-6"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useMenuResponse"))),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetchMenu.ts#L50"},"packages/core/src/react/hooks/useFetchMenu.ts:50")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchposts"},"useFetchPosts"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchPosts"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fetcher?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useFetchPosts hook. Returns a collection of post entities"),(0,r.kt)("p",null,"See usePosts for usage instructions."),(0,r.kt)("h4",{id:"type-parameters-2"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,r.kt)("h4",{id:"parameters-7"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The list of params to pass to the fetch strategy. It overrides the ones in the URL.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The options to pass to the swr hook.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path of the url to get url params from.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetcher")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},(0,r.kt)("inlineCode",{parentName:"a"},"PostsArchiveFetchStrategy")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The fetch strategy to use. If none is passed, the default one is used")))),(0,r.kt)("h4",{id:"returns-7"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetchPosts.ts#L81"},"packages/core/src/react/hooks/useFetchPosts.ts:81")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchsearch"},"useFetchSearch"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchSearch"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useSearchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useFetchSearch hook. Returns a collection of post entities"),(0,r.kt)("p",null,"See useSearch for usage instructions."),(0,r.kt)("h4",{id:"type-parameters-3"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,r.kt)("h4",{id:"parameters-8"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The list of params to pass to the fetch strategy. It overrides the ones in the URL.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The options to pass to the swr hook.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path of the url to get url params from.")))),(0,r.kt)("h4",{id:"returns-8"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useSearchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetchSearch.ts#L34"},"packages/core/src/react/hooks/useFetchSearch.ts:34")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchsearchnative"},"useFetchSearchNative"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchSearchNative"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useSearchNativeResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useSearchNativeResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useFetchSearchNative hook. Returns a collection of search entities retrieved through the WP native search endpoint"),(0,r.kt)("p",null,"See useSearchNative for usage instructions."),(0,r.kt)("h4",{id:"type-parameters-4"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostSearchEntity"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermSearchEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermSearchEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostSearchEntity"))," ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermSearchEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermSearchEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.SearchParams"},(0,r.kt)("inlineCode",{parentName:"a"},"SearchParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.SearchParams"},(0,r.kt)("inlineCode",{parentName:"a"},"SearchParams")))))),(0,r.kt)("h4",{id:"parameters-9"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The list of params to pass to the fetch strategy. It overrides the ones in the URL.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The options to pass to the swr hook.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path of the url to get url params from.")))),(0,r.kt)("h4",{id:"returns-9"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useSearchNativeResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useSearchNativeResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetchSearchNative.ts#L37"},"packages/core/src/react/hooks/useFetchSearchNative.ts:37")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchterms"},"useFetchTerms"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchTerms"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useTermsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useFetchTerms hook. Returns a collection of term entities"),(0,r.kt)("p",null,"See useTerms for usage instructions."),(0,r.kt)("h4",{id:"type-parameters-5"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"TaxonomyArchiveParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"TaxonomyArchiveParams")))))),(0,r.kt)("h4",{id:"parameters-10"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The list of params to pass to the fetch strategy. It overrides the ones in the URL.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The options to pass to the swr hook.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path of the url to get url params from.")))),(0,r.kt)("h4",{id:"returns-10"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"useTermsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetchTerms.ts#L31"},"packages/core/src/react/hooks/useFetchTerms.ts:31")),(0,r.kt)("h2",{id:"other"},"Other"),(0,r.kt)("h3",{id:"align"},"Align"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Align"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"none"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"left"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"center"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"right"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"wide"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"full"')),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L15"},"packages/core/src/react/blocks/types.ts:15")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"border"},"Border"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Border"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"radius?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"style?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"width?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L65"},"packages/core/src/react/blocks/types.ts:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"datafetchingproviderprops"},"DataFetchingProviderProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"DataFetchingProviderProps"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRConfiguration"),"[",(0,r.kt)("inlineCode",{parentName:"td"},'"fallback"'),"]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"swrConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRConfiguration")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Pass any configuration to the SWR library. Globally. These settings can be overridden at the hook level.")))),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/DataFetchingProvider.tsx#L6"},"packages/core/src/react/provider/DataFetchingProvider.tsx:6")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"itemwrapper"},"ItemWrapper"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ItemWrapper"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#itemwrapperprops"},(0,r.kt)("inlineCode",{parentName:"a"},"ItemWrapperProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h5",{id:"parameters-11"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#itemwrapperprops"},(0,r.kt)("inlineCode",{parentName:"a"},"ItemWrapperProps")))))),(0,r.kt)("h5",{id:"returns-11"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/Menu.tsx#L15"},"packages/core/src/react/components/Menu.tsx:15")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"itemwrapperprops"},"ItemWrapperProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ItemWrapperProps"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"PropsWithChildren"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"className"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"depth"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"item"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"MenuItemEntity"))," }",">"),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/Menu.tsx#L10"},"packages/core/src/react/components/Menu.tsx:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"linkwrapper"},"LinkWrapper"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"LinkWrapper"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#linkwrapperprops"},(0,r.kt)("inlineCode",{parentName:"a"},"LinkWrapperProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h5",{id:"parameters-12"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#linkwrapperprops"},(0,r.kt)("inlineCode",{parentName:"a"},"LinkWrapperProps")))))),(0,r.kt)("h5",{id:"returns-12"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/Menu.tsx#L27"},"packages/core/src/react/components/Menu.tsx:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"linkwrapperprops"},"LinkWrapperProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"LinkWrapperProps"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"PropsWithChildren"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"depth"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"href"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }",">"),(0,r.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/Menu.tsx#L23"},"packages/core/src/react/components/Menu.tsx:23")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"menuitemsprop"},"MenuItemsProp"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"MenuItemsProp"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-4"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"depth")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"itemWrapper")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#itemwrapper"},(0,r.kt)("inlineCode",{parentName:"a"},"ItemWrapper")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"items")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"MenuItemEntity")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"linkWrapper")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#linkwrapper"},(0,r.kt)("inlineCode",{parentName:"a"},"LinkWrapper")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"menuWrapper")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#menuwrapper"},(0,r.kt)("inlineCode",{parentName:"a"},"MenuWrapper")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"topLevelItemsClickable")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/Menu.tsx#L29"},"packages/core/src/react/components/Menu.tsx:29")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"menuwrapper"},"MenuWrapper"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"MenuWrapper"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#menuwrapperprops"},(0,r.kt)("inlineCode",{parentName:"a"},"MenuWrapperProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h4",{id:"type-declaration-5"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h5",{id:"parameters-13"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#menuwrapperprops"},(0,r.kt)("inlineCode",{parentName:"a"},"MenuWrapperProps")))))),(0,r.kt)("h5",{id:"returns-13"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"JSX.Element")),(0,r.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/Menu.tsx#L21"},"packages/core/src/react/components/Menu.tsx:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"menuwrapperprops"},"MenuWrapperProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"MenuWrapperProps"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"PropsWithChildren"),"<{ ",(0,r.kt)("inlineCode",{parentName:"p"},"className"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"depth"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," }",">"),(0,r.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/Menu.tsx#L17"},"packages/core/src/react/components/Menu.tsx:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"pagetype"},"PageType"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"PageType"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-6"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isAuthorArchive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Author Archive")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isCategoryArchive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Category Archive")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isPostArchive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Regular post archive")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isPostTypeArchive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Custom Post Type Archive")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isSearch")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Search route")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isTagArchive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Tag Archive")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"isTaxonomyArchive")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Custom Taxonomy Archive")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"postType")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Which post type this archive is for")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"taxonomy")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Which taxonomy this archive is for")))),(0,r.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetchPosts.ts#L20"},"packages/core/src/react/hooks/useFetchPosts.ts:20")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingscolorpalette"},"SettingsColorPalette"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsColorPalette"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-7"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingscolorpreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsColorPreset")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"theme?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingscolorpreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsColorPreset")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"user?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingscolorpreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsColorPreset")),"[]")))),(0,r.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L47"},"packages/core/src/react/provider/types.ts:47")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingscolorpreset"},"SettingsColorPreset"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsColorPreset"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-8"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"color")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"CSS hex or rgb(a) string.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Name of the color preset, translatable.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Kebab-case unique identifier for the color preset.")))),(0,r.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L32"},"packages/core/src/react/provider/types.ts:32")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingscontextprops"},"SettingsContextProps"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsContextProps"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"imageComponent?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"React.FC"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IImageBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IImageBlock")),">"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"linkComponent?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactNode")," } & ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig"))),(0,r.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L5"},"packages/core/src/react/provider/types.ts:5")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingsduotone"},"SettingsDuotone"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsDuotone"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-9"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsduotonepreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsDuotonePreset")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"theme?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsduotonepreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsDuotonePreset")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"user?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsduotonepreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsDuotonePreset")),"[]")))),(0,r.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L89"},"packages/core/src/react/provider/types.ts:89")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingsduotonepreset"},"SettingsDuotonePreset"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsDuotonePreset"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-10"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"colors")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"),"[]"),(0,r.kt)("td",{parentName:"tr",align:"left"},"List of colors from dark to light.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Name of the duotone preset, translatable.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Kebab-case unique identifier for the duotone preset.")))),(0,r.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L74"},"packages/core/src/react/provider/types.ts:74")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingsgradient"},"SettingsGradient"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsGradient"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-11"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"default?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsgradientpreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsGradientPreset")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"theme?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsgradientpreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsGradientPreset")),"[]")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"user?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#settingsgradientpreset"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsGradientPreset")),"[]")))),(0,r.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L68"},"packages/core/src/react/provider/types.ts:68")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingsgradientpreset"},"SettingsGradientPreset"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsGradientPreset"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-12"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"gradient")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"CSS gradient string.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Name of the gradient preset, translatable.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Kebab-case unique identifier for the gradient preset.")))),(0,r.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L53"},"packages/core/src/react/provider/types.ts:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingspropertiescomplete"},"SettingsPropertiesComplete"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"SettingsPropertiesComplete"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"border?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"border"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"color"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"custom?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"custom"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"layout?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"layout"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"spacing?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"spacing"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"typography?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"typography"'),"]"," }"),(0,r.kt)("h4",{id:"defined-in-29"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L10"},"packages/core/src/react/provider/types.ts:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"spacing"},"Spacing"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Spacing"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-13"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"blockGap")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"bottom"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"left"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"right"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"top"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.bottom")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.left")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.right")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.top")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"bottom"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"left"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"right"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"top"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.bottom")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.left")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.right")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.top")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"supportsBlockGap")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"supportsMargin")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"supportsPadding")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"defined-in-30"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L40"},"packages/core/src/react/blocks/types.ts:40")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"style"},"Style"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"Style"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-14"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"border")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,r.kt)("inlineCode",{parentName:"a"},"Border")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"spacing")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,r.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"typography")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,r.kt)("inlineCode",{parentName:"a"},"Typography")))))),(0,r.kt)("h4",{id:"defined-in-31"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L17"},"packages/core/src/react/blocks/types.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"stylespropertiesandelementscomplete"},"StylesPropertiesAndElementsComplete"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"StylesPropertiesAndElementsComplete"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesProperties"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"border?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"border"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"color"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"elements?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesElementsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"spacing?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"spacing"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"typography?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"typography"'),"]"," }"),(0,r.kt)("h4",{id:"defined-in-32"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L24"},"packages/core/src/react/provider/types.ts:24")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"stylespropertiescomplete"},"StylesPropertiesComplete"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"StylesPropertiesComplete"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesProperties"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"border?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"border"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"color"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"spacing?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"spacing"'),"]"," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"typography?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties")),"[",(0,r.kt)("inlineCode",{parentName:"p"},'"typography"'),"]"," }"),(0,r.kt)("h4",{id:"defined-in-33"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L18"},"packages/core/src/react/provider/types.ts:18")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"themejson"},"ThemeJSON"),(0,r.kt)("p",null,"\u01ac ",(0,r.kt)("strong",{parentName:"p"},"ThemeJSON"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Pick"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.WpThemeJSON"},(0,r.kt)("inlineCode",{parentName:"a"},"WpThemeJSON")),", ",(0,r.kt)("inlineCode",{parentName:"p"},'"styles"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"settings"'),">"),(0,r.kt)("h4",{id:"defined-in-34"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L352"},"packages/core/src/react/provider/types.ts:352")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingscontext"},"SettingsContext"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"SettingsContext"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Context"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingscontextprops"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsContextProps")),">",">"),(0,r.kt)("h4",{id:"defined-in-35"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/Provider.tsx#L5"},"packages/core/src/react/provider/Provider.tsx:5")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"themesettingscontext"},"ThemeSettingsContext"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"ThemeSettingsContext"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Context"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#themejson"},(0,r.kt)("inlineCode",{parentName:"a"},"ThemeJSON")),">"),(0,r.kt)("h4",{id:"defined-in-36"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/ThemeSettingsProvider.tsx#L4"},"packages/core/src/react/provider/ThemeSettingsProvider.tsx:4")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"defaultelement"},"defaultElement"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Const")," ",(0,r.kt)("strong",{parentName:"p"},"defaultElement"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("h4",{id:"defined-in-37"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/hooks/useBlock.ts#L8"},"packages/core/src/react/blocks/hooks/useBlock.ts:8")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"columnblock"},"ColumnBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ColumnBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-14"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IColumnBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IColumnBlock")))))),(0,r.kt)("h4",{id:"returns-14"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-38"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/ColumnBlock.tsx#L11"},"packages/core/src/react/blocks/ColumnBlock.tsx:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"columnsblock"},"ColumnsBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ColumnsBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-15"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IColumnsBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IColumnsBlock")))))),(0,r.kt)("h4",{id:"returns-15"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-39"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/ColumnsBlocks.tsx#L11"},"packages/core/src/react/blocks/ColumnsBlocks.tsx:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"coverblock"},"CoverBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"CoverBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-16"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ICoverBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"ICoverBlock")))))),(0,r.kt)("h4",{id:"returns-16"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-40"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/CoverBlock.tsx#L24"},"packages/core/src/react/blocks/CoverBlock.tsx:24")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"datafetchingprovider"},"DataFetchingProvider"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"DataFetchingProvider"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"context?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"parameters-17"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"PropsWithChildren"),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#datafetchingproviderprops"},(0,r.kt)("inlineCode",{parentName:"a"},"DataFetchingProviderProps")),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"context?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"returns-17"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-41"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/react/index.d.ts:542"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"debugblock"},"DebugBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"DebugBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-18"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object"))))),(0,r.kt)("h4",{id:"returns-18"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-42"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/DebugBlock.tsx#L7"},"packages/core/src/react/blocks/DebugBlock.tsx:7")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"fileblock"},"FileBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"FileBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-19"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IFileBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IFileBlock")))))),(0,r.kt)("h4",{id:"returns-19"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-43"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/FileBlock.tsx#L14"},"packages/core/src/react/blocks/FileBlock.tsx:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"groupblock"},"GroupBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"GroupBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-20"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IGroupBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IGroupBlock")))))),(0,r.kt)("h4",{id:"returns-20"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-44"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/GroupBlock.tsx#L17"},"packages/core/src/react/blocks/GroupBlock.tsx:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"headingblock"},"HeadingBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"HeadingBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-21"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IHeadingBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IHeadingBlock")))))),(0,r.kt)("h4",{id:"returns-21"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-45"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/HeadingBlock.tsx#L12"},"packages/core/src/react/blocks/HeadingBlock.tsx:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"imageblock"},"ImageBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ImageBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-22"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IImageBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IImageBlock")))))),(0,r.kt)("h4",{id:"returns-22"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-46"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/ImageBlock.tsx#L19"},"packages/core/src/react/blocks/ImageBlock.tsx:19")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"listblock"},"ListBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ListBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-23"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IListBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IListBlock")))))),(0,r.kt)("h4",{id:"returns-23"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-47"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/ListBlock.tsx#L12"},"packages/core/src/react/blocks/ListBlock.tsx:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"mediatextblock"},"MediaTextBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"MediaTextBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-24"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IMediaTextBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IMediaTextBlock")))))),(0,r.kt)("h4",{id:"returns-24"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-48"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/MediaTextBlock.tsx#L22"},"packages/core/src/react/blocks/MediaTextBlock.tsx:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"menu"},"Menu"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"Menu"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-25"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"MenuProps"))))),(0,r.kt)("h4",{id:"returns-25"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-49"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/Menu.tsx#L109"},"packages/core/src/react/components/Menu.tsx:109")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"menuitems"},"MenuItems"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"MenuItems"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-26"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#menuitemsprop"},(0,r.kt)("inlineCode",{parentName:"a"},"MenuItemsProp")))))),(0,r.kt)("h4",{id:"returns-26"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-50"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/Menu.tsx#L54"},"packages/core/src/react/components/Menu.tsx:54")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"paragraphblock"},"ParagraphBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ParagraphBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-27"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IParagraphBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IParagraphBlock")))))),(0,r.kt)("h4",{id:"returns-27"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-51"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/ParagraphBlock.tsx#L13"},"packages/core/src/react/blocks/ParagraphBlock.tsx:13")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"preformattedblock"},"PreformattedBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"PreformattedBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-28"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IPreformattedBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IPreformattedBlock")))))),(0,r.kt)("h4",{id:"returns-28"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-52"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/PreformatedBlock.tsx#L11"},"packages/core/src/react/blocks/PreformatedBlock.tsx:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"pullquoteblock"},"PullQuoteBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"PullQuoteBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-29"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IPullQuoteBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IPullQuoteBlock")))))),(0,r.kt)("h4",{id:"returns-29"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-53"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/PullQuote.tsx#L15"},"packages/core/src/react/blocks/PullQuote.tsx:15")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"quoteblock"},"QuoteBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"QuoteBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-30"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IQuoteBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IQuoteBlock")))))),(0,r.kt)("h4",{id:"returns-30"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-54"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/QuoteBlock.tsx#L10"},"packages/core/src/react/blocks/QuoteBlock.tsx:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"separatorblock"},"SeparatorBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"SeparatorBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-31"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ISeparatorBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"ISeparatorBlock")))))),(0,r.kt)("h4",{id:"returns-31"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-55"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/SeparatorBlock.tsx#L10"},"packages/core/src/react/blocks/SeparatorBlock.tsx:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settingsprovider"},"SettingsProvider"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"SettingsProvider"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"context?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"parameters-32"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"PropsWithChildren"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"ProviderProps"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"context?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"returns-32"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-56"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/react/index.d.ts:542"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"spacerblock"},"SpacerBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"SpacerBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-33"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ISpacerBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"ISpacerBlock")))))),(0,r.kt)("h4",{id:"returns-33"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-57"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/SpacerBlock.tsx#L12"},"packages/core/src/react/blocks/SpacerBlock.tsx:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tableblock"},"TableBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"TableBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-34"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ITableBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"ITableBlock")))))),(0,r.kt)("h4",{id:"returns-34"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-58"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/TableBlock.tsx#L12"},"packages/core/src/react/blocks/TableBlock.tsx:12")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"themesettingsprovider"},"ThemeSettingsProvider"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"ThemeSettingsProvider"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"context?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"parameters-35"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"PropsWithChildren"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"ProviderProps"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"context?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"returns-35"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-59"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/react/index.d.ts:542"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"verseblock"},"VerseBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"VerseBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"\xabdestructured\xbb"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"parameters-36"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"\xabdestructured\xbb")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IVerseBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IVerseBlock")))))),(0,r.kt)("h4",{id:"returns-36"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-60"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/VerseBlock.tsx#L11"},"packages/core/src/react/blocks/VerseBlock.tsx:11")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"youtubeliteblock"},"YoutubeLiteBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"YoutubeLiteBlock"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"Renders Youtube embeds with lite-youtube-embed"),(0,r.kt)("h4",{id:"parameters-37"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Omit"),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IYoutubeLiteBlock")),", ",(0,r.kt)("inlineCode",{parentName:"td"},'"component"'),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"The Block props")))),(0,r.kt)("h4",{id:"returns-37"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-61"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/YoutubeLiteBlock.tsx#L41"},"packages/core/src/react/blocks/YoutubeLiteBlock.tsx:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getalignstyle"},"getAlignStyle"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getAlignStyle"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},'"none"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"left"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"center"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"right"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"wide"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"full"')),(0,r.kt)("h4",{id:"parameters-38"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"domNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))))),(0,r.kt)("h4",{id:"returns-38"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},'"none"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"left"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"center"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"right"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"wide"')," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},'"full"')),(0,r.kt)("h4",{id:"defined-in-62"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/utils.ts#L5"},"packages/core/src/react/blocks/utils.ts:5")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getblockstyle"},"getBlockStyle"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getBlockStyle"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Returns the block style (is-style-{block-style})"),(0,r.kt)("h4",{id:"parameters-39"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"domNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-39"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"string with block style"),(0,r.kt)("h4",{id:"defined-in-63"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/utils.ts#L39"},"packages/core/src/react/blocks/utils.ts:39")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getcolorstyles"},"getColorStyles"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getColorStyles"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,r.kt)("inlineCode",{parentName:"a"},"Colors"))),(0,r.kt)("p",null,"Infer GB color styles from classnames"),(0,r.kt)("h4",{id:"parameters-40"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"domNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-40"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,r.kt)("inlineCode",{parentName:"a"},"Colors"))),(0,r.kt)("p",null,"ColorBlockProps object"),(0,r.kt)("h4",{id:"defined-in-64"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/utils.ts#L62"},"packages/core/src/react/blocks/utils.ts:62")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getinlinestyles"},"getInlineStyles"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getInlineStyles"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"Converts inline styles to a stylesObject for use in react components"),(0,r.kt)("h4",{id:"parameters-41"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"domNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-41"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"false")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("h4",{id:"defined-in-65"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/utils.ts#L120"},"packages/core/src/react/blocks/utils.ts:120")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"gettypographystyles"},"getTypographyStyles"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getTypographyStyles"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Returns the typography styles of a block"),(0,r.kt)("h4",{id:"parameters-42"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"domNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-42"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontSize")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"style")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"fontSize"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," = ''; ",(0,r.kt)("inlineCode",{parentName:"td"},"lineHeight"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," = '' }")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"style.fontSize")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"style.lineHeight")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-66"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/utils.ts#L177"},"packages/core/src/react/blocks/utils.ts:177")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"getwidthstyles"},"getWidthStyles"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"getWidthStyles"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Returns the width size of a block"),(0,r.kt)("h4",{id:"parameters-43"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"domNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-43"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-67"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/utils.ts#L149"},"packages/core/src/react/blocks/utils.ts:149")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"parseseo"},"parseSeo"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"parseSeo"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"seo"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Element"),"[]"),(0,r.kt)("h4",{id:"parameters-44"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"seo")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"HTMLReactParserOptions")))))),(0,r.kt)("h4",{id:"returns-44"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Element"),"[]"),(0,r.kt)("h4",{id:"defined-in-68"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/utils/parseSeo.ts#L4"},"packages/core/src/react/utils/parseSeo.ts:4")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"safearrayspread"},"safeArraySpread"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"safeArraySpread"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"array"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),"[]"),(0,r.kt)("h4",{id:"parameters-45"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"array")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"returns-45"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"any"),"[]"),(0,r.kt)("h4",{id:"defined-in-69"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/utils.ts#L220"},"packages/core/src/react/blocks/utils.ts:220")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"serializekey"},"serializeKey"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"serializeKey"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"parameters-46"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Key"))))),(0,r.kt)("h4",{id:"returns-46"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-70"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/core/dist/index.d.ts:17"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblock"},"useBlock"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlock"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"node?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Returns the block name and attributes"),(0,r.kt)("h4",{id:"type-parameters-6"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,r.kt)("inlineCode",{parentName:"a"},"IBlockAttributes")))))),(0,r.kt)("h4",{id:"parameters-47"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-47"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"attributes")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"className")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-71"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/hooks/useBlock.ts#L38"},"packages/core/src/react/blocks/hooks/useBlock.ts:38")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblockalign"},"useBlockAlign"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockAlign"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,r.kt)("inlineCode",{parentName:"a"},"Align"))),(0,r.kt)("p",null,"Returns the block align style (if available)"),(0,r.kt)("h4",{id:"parameters-48"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-48"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,r.kt)("inlineCode",{parentName:"a"},"Align"))),(0,r.kt)("h4",{id:"defined-in-72"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/hooks/useBlockAlign.ts#L16"},"packages/core/src/react/blocks/hooks/useBlockAlign.ts:16")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblockattributes"},"useBlockAttributes"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockAttributes"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"useBlockAttributes hooks returns the block attributes for a given block based on what it supports"),(0,r.kt)("h4",{id:"parameters-49"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"The reference to the dom node of the block")))),(0,r.kt)("h4",{id:"returns-49"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"align")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,r.kt)("inlineCode",{parentName:"a"},"Align")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"blockStyle")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"border")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,r.kt)("inlineCode",{parentName:"a"},"Border")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"colors")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,r.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"spacing")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,r.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"typography")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,r.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"width")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-73"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/hooks/useBlockAttributes.ts#L19"},"packages/core/src/react/blocks/hooks/useBlockAttributes.ts:19")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblockborder"},"useBlockBorder"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockBorder"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,r.kt)("inlineCode",{parentName:"a"},"Border"))),(0,r.kt)("p",null,"Returns the block style (if available)"),(0,r.kt)("h4",{id:"parameters-50"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-50"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,r.kt)("inlineCode",{parentName:"a"},"Border"))),(0,r.kt)("h4",{id:"defined-in-74"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/hooks/useBlockBorder.ts#L17"},"packages/core/src/react/blocks/hooks/useBlockBorder.ts:17")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblockcolors"},"useBlockColors"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockColors"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,r.kt)("inlineCode",{parentName:"a"},"Colors"))),(0,r.kt)("p",null,"Returns the block style (if available)"),(0,r.kt)("h4",{id:"parameters-51"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-51"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,r.kt)("inlineCode",{parentName:"a"},"Colors"))),(0,r.kt)("h4",{id:"defined-in-75"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/hooks/useBlockColors.ts#L25"},"packages/core/src/react/blocks/hooks/useBlockColors.ts:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblockspacing"},"useBlockSpacing"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockSpacing"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,r.kt)("inlineCode",{parentName:"a"},"Spacing"))),(0,r.kt)("p",null,"Returns the block style (if available)"),(0,r.kt)("h4",{id:"parameters-52"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-52"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,r.kt)("inlineCode",{parentName:"a"},"Spacing"))),(0,r.kt)("h4",{id:"defined-in-76"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/hooks/useBlockSpacing.ts#L21"},"packages/core/src/react/blocks/hooks/useBlockSpacing.ts:21")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblockstyle"},"useBlockStyle"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockStyle"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Returns the block style (if available)"),(0,r.kt)("h4",{id:"parameters-53"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-53"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-77"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/hooks/useBlockStyle.ts#L10"},"packages/core/src/react/blocks/hooks/useBlockStyle.ts:10")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblocktypography"},"useBlockTypography"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockTypography"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,r.kt)("inlineCode",{parentName:"a"},"Typography"))),(0,r.kt)("p",null,"Returns the block style (if available)"),(0,r.kt)("h4",{id:"parameters-54"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-54"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,r.kt)("inlineCode",{parentName:"a"},"Typography"))),(0,r.kt)("h4",{id:"defined-in-78"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/hooks/useBlockTypography.ts#L25"},"packages/core/src/react/blocks/hooks/useBlockTypography.ts:25")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useblockwidth"},"useBlockWidth"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useBlockWidth"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"node"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Returns the block style (if available)"),(0,r.kt)("h4",{id:"parameters-55"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"node")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"DomNode")))),(0,r.kt)("h4",{id:"returns-55"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in-79"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/hooks/useBlockWidth.ts#L16"},"packages/core/src/react/blocks/hooks/useBlockWidth.ts:16")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchauthorarchive"},"useFetchAuthorArchive"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchAuthorArchive"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"The useFetchAuthorArchive hook"),(0,r.kt)("p",null,"See useAuthorArchive"),(0,r.kt)("h4",{id:"type-parameters-7"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,r.kt)("h4",{id:"parameters-56"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The list of params to pass to the fetch strategy. It overrides the ones in the URL.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),"[]",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The options to pass to the swr hook.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path of the url to get url params from.")))),(0,r.kt)("h4",{id:"returns-56"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostsResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-80"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetchAuthorArchive.ts#L22"},"packages/core/src/react/hooks/useFetchAuthorArchive.ts:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchpost"},"useFetchPost"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchPost"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"type-parameters-8"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostParams")))))),(0,r.kt)("h4",{id:"parameters-57"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{} ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''"))))),(0,r.kt)("h4",{id:"returns-57"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-81"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetchPost.ts#L36"},"packages/core/src/react/hooks/useFetchPost.ts:36")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usefetchpostorposts"},"useFetchPostOrPosts"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useFetchPostOrPosts"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"params?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"options?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"path?"),"): ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostOrPostResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"type-parameters-9"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostOrPostsParams"))," = ",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},(0,r.kt)("inlineCode",{parentName:"a"},"PostOrPostsParams")))))),(0,r.kt)("h4",{id:"parameters-58"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"params")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"options")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchHookOptions")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#postorpostsfetchstrategyresult"},(0,r.kt)("inlineCode",{parentName:"a"},"PostOrPostsFetchStrategyResult")),"<",(0,r.kt)("inlineCode",{parentName:"td"},"T"),">",">",">"),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"{}"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''"))))),(0,r.kt)("h4",{id:"returns-58"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse"},(0,r.kt)("inlineCode",{parentName:"a"},"usePostOrPostResponse")),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("h4",{id:"defined-in-82"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetchPostOrPosts.ts#L32"},"packages/core/src/react/hooks/useFetchPostOrPosts.ts:32")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useswr"},"useSWR"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRKey"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-10"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Key")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"StrictKey"))))),(0,r.kt)("h4",{id:"parameters-59"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"))))),(0,r.kt)("h4",{id:"returns-59"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-83"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:200"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRKey"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fetcher"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-11"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Key")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"StrictKey"))))),(0,r.kt)("h4",{id:"parameters-60"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetcher")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Fetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"),">")))),(0,r.kt)("h4",{id:"returns-60"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-84"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:201"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRKey"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"config"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-12"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Key")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"StrictKey"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Fetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"),">",">",">"," = ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Fetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"),">",">",">")))),(0,r.kt)("h4",{id:"parameters-61"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"config")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions"))))),(0,r.kt)("h4",{id:"returns-61"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("h4",{id:"defined-in-85"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:202"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRKey"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fetcher"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"config"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-13"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"Key")," = ",(0,r.kt)("inlineCode",{parentName:"td"},"StrictKey"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Fetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"),">",">",">"," = ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Fetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"),">",">",">")))),(0,r.kt)("h4",{id:"parameters-62"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetcher")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Fetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"SWRKey"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"config")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions"))))),(0,r.kt)("h4",{id:"returns-62"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("h4",{id:"defined-in-86"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:203"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-14"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"parameters-63"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Key"))))),(0,r.kt)("h4",{id:"returns-63"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-87"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:204"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fetcher"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-15"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))))),(0,r.kt)("h4",{id:"parameters-64"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Key"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetcher")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),">")))),(0,r.kt)("h4",{id:"returns-64"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-88"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:205"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"config"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-16"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),">",">",">"," = ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),">",">",">")))),(0,r.kt)("h4",{id:"parameters-65"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Key"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"config")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions"))))),(0,r.kt)("h4",{id:"returns-65"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("h4",{id:"defined-in-89"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:206"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWR"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">","(",(0,r.kt)("inlineCode",{parentName:"p"},"key"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fetcher"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"config"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("p",null,"A hook to fetch data."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Link"))),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app"},"https://swr.vercel.app")),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Example"))),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"import useSWR from 'swr'\nfunction Profile() {\n const { data, error } = useSWR('/api/user', fetcher)\n if (error) return
failed to load
\n if (!data) return
loading...
\n return
hello {data.name}!
\n}\n")),(0,r.kt)("h4",{id:"type-parameters-17"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Data")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Error")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),">",">",">"," = ",(0,r.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"PublicConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"td"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),">",">",">")))),(0,r.kt)("h4",{id:"parameters-66"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"key")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Key"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fetcher")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"td"},"Data"),">")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"config")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"SWROptions"))))),(0,r.kt)("h4",{id:"returns-66"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"SWRResponse"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"Data"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"SWROptions"),">"),(0,r.kt)("h4",{id:"defined-in-90"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:207"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"useswrconfig"},"useSWRConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSWRConfig"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"FullConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">",">"),(0,r.kt)("h4",{id:"returns-67"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"FullConfiguration"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"BareFetcher"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">",">"),(0,r.kt)("h4",{id:"defined-in-91"},"Defined in"),(0,r.kt)("p",null,"node_modules/swr/_internal/dist/index.d.ts:336"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usesettings"},"useSettings"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useSettings"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingscontextprops"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsContextProps")),">"),(0,r.kt)("h4",{id:"returns-68"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingscontextprops"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsContextProps")),">"),(0,r.kt)("h4",{id:"defined-in-92"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/useSettings.ts#L4"},"packages/core/src/react/provider/useSettings.ts:4")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usethemesetting"},"useThemeSetting"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useThemeSetting"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"blockName?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"defaultValue?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"fallbackToGlobalSetting?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("p",null,"Returns a single theme setting normalized"),(0,r.kt)("h4",{id:"parameters-67"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Default value"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"path")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"undefined")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The path to the setting")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"blockName")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The block name")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"defaultValue")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"''")),(0,r.kt)("td",{parentName:"tr",align:"left"},"the default value to return")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fallbackToGlobalSetting")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"true")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Whether it should fallback to global setting if blockName is passed but setting does not exist")))),(0,r.kt)("h4",{id:"returns-69"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"any")),(0,r.kt)("h4",{id:"defined-in-93"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/useThemeSetting.ts#L22"},"packages/core/src/react/provider/useThemeSetting.ts:22")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usethemesettings"},"useThemeSettings"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useThemeSettings"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"blocks?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"core/archives?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/audio?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/block?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/button?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/buttons?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/calendar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/categories?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/code?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/column?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-avatar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-name?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-edit-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-reply-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comments-query-loop?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/cover?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/embed?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/file?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/freeform?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/gallery?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/heading?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/home-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/html?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-posts?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/legacy-widget?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/loginout?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/media-text?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/missing?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/more?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/nextpage?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/page-list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/paragraph?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-author?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-count?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-form?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-excerpt?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-featured-image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-terms?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/preformatted?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/pullquote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-next?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-numbers?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-previous?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/quote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/rss?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/search?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/separator?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/shortcode?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-logo?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-tagline?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-links?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/spacer?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table-of-contents?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/tag-cloud?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/template-part?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/term-description?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/text-columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/verse?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/video?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-area?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"border?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"radius?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"style?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"width?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"background?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"custom?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"customDuotone?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"customGradient?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"defaultGradients?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"defaultPalette?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"duotone?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingsduotone"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsDuotone"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"gradients?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingsgradient"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsGradient"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"link?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"palette?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingscolorpalette"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsColorPalette"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"text?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"custom?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"[k: string]"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsCustomAdditionalProperties")),"; } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"layout?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"contentSize?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"wideSize?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"spacing?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"blockGap?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"margin?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"padding?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"units?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[] } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"typography?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"customFontSize?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"dropCap?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontFamilies?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"fontFamily?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"name?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"slug?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontSizes?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"name?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"size?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"slug?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontStyle?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontWeight?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"letterSpacing?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"lineHeight?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"textDecoration?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"textTransform?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } }"),(0,r.kt)("p",null,"Returns the raw theme.json settings definitions"),(0,r.kt)("h4",{id:"returns-70"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsProperties"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"blocks?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"core/archives?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/audio?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/block?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/button?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/buttons?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/calendar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/categories?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/code?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/column?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-avatar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-name?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-edit-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-reply-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comments-query-loop?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/cover?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/embed?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/file?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/freeform?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/gallery?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/heading?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/home-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/html?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-posts?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/legacy-widget?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/loginout?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/media-text?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/missing?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/more?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/nextpage?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/page-list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/paragraph?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-author?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-count?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-form?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-excerpt?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-featured-image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-terms?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/preformatted?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/pullquote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-next?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-numbers?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-previous?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/quote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/rss?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/search?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/separator?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/shortcode?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-logo?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-tagline?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-links?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/spacer?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table-of-contents?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/tag-cloud?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/template-part?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/term-description?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/text-columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/verse?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/video?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-area?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"border?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"radius?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"style?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"width?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"background?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"custom?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"customDuotone?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"customGradient?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"defaultGradients?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"defaultPalette?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"duotone?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingsduotone"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsDuotone"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"gradients?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingsgradient"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsGradient"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"link?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"palette?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingscolorpalette"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsColorPalette"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"text?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"custom?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"[k: string]"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"SettingsCustomAdditionalProperties")),"; } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"layout?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"contentSize?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"wideSize?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"spacing?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"blockGap?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"margin?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"padding?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"units?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[] } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"typography?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"customFontSize?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"dropCap?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontFamilies?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"fontFamily?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"name?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"slug?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontSizes?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"name?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"size?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"slug?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," }[] ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontStyle?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"fontWeight?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"letterSpacing?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"lineHeight?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"textDecoration?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"textTransform?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")," } }"),(0,r.kt)("h4",{id:"defined-in-94"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/useThemeSettings.ts#L9"},"packages/core/src/react/provider/useThemeSettings.ts:9")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"usethemestyles"},"useThemeStyles"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"useThemeStyles"),"(): ",(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesProperties"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"blocks?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"core/archives?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/audio?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/block?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/button?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/buttons?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/calendar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/categories?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/code?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/column?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-avatar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-name?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-edit-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-reply-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comments-query-loop?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/cover?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/embed?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/file?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/freeform?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/gallery?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/heading?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/home-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/html?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-posts?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/legacy-widget?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/loginout?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/media-text?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/missing?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/more?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/nextpage?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/page-list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/paragraph?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-author?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-count?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-form?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-excerpt?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-featured-image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-terms?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/preformatted?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/pullquote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-next?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-numbers?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-previous?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/quote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/rss?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/search?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/separator?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/shortcode?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-logo?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-tagline?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-links?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/spacer?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table-of-contents?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/tag-cloud?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/template-part?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/term-description?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/text-columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/verse?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/video?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-area?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"border?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"elements?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"h1?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h2?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h3?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h4?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h5?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h6?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"spacing?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"typography?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," }"),(0,r.kt)("p",null,"Returns the theme.json styles definitions"),(0,r.kt)("h4",{id:"returns-71"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"undefined")," ","|"," ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesProperties"))," & { ",(0,r.kt)("inlineCode",{parentName:"p"},"blocks?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"core/archives?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/audio?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/block?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/button?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/buttons?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/calendar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/categories?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/code?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/column?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-avatar?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-author-name?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-edit-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-reply-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comment-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/comments-query-loop?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/cover?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/embed?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/file?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/freeform?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/gallery?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/heading?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/home-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/html?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/latest-posts?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/legacy-widget?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/loginout?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/media-text?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/missing?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/more?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/nextpage?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/page-list?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/paragraph?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-author?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-count?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-form?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-comments-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-content?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-date?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-excerpt?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-featured-image?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-navigation-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-template?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-terms?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/post-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/preformatted?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/pullquote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-next?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-numbers?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-pagination-previous?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/query-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/quote?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/rss?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/search?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/separator?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/shortcode?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-logo?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-tagline?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/site-title?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/social-links?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/spacer?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/table-of-contents?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/tag-cloud?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/template-part?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/term-description?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/text-columns?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/verse?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/video?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-area?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"core/widget-group?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"border?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"elements?"),": { ",(0,r.kt)("inlineCode",{parentName:"p"},"h1?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h2?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h3?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h4?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h5?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"h6?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"link?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,r.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," } ; ",(0,r.kt)("inlineCode",{parentName:"p"},"spacing?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,r.kt)("inlineCode",{parentName:"p"},"typography?"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")," }"),(0,r.kt)("h4",{id:"defined-in-95"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/useThemeStyles.ts#L9"},"packages/core/src/react/provider/useThemeStyles.ts:9")),(0,r.kt)("h2",{id:"react-components"},"React Components"),(0,r.kt)("h3",{id:"blocksrenderer"},"BlocksRenderer"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"BlocksRenderer"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"BlocksRenderer")," components provides an easy way to convert HTML markup into corresponding\nReact components."),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"BlocksRenderer")," component takes in arbitrary html markup and receives a list of react components\nas children that allows replacing dom nodes with React Components."),(0,r.kt)("p",null,"The html prop is sanitized through ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#wpksespost"},"wpKsesPost")," so it's safe for rendering arbitrary html markup."),(0,r.kt)("p",null,"The children components must implement the ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.BlockProps"},"BlockProps")," interface"),(0,r.kt)("h4",{id:"usage-1"},"Usage"),(0,r.kt)("h5",{id:"usage-with-the-test-function"},"Usage with the test function"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},"\n isAnchorTag(node, { isInternalLink: true })} />\n\n")),(0,r.kt)("h5",{id:"usage-with-classlist-and-tagname-props"},"Usage with classList and tagName props"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},'\n \n\n')),(0,r.kt)("h4",{id:"parameters-68"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.BlockRendererProps"},(0,r.kt)("inlineCode",{parentName:"a"},"BlockRendererProps"))),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component properties")))),(0,r.kt)("h4",{id:"returns-72"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"Element")),(0,r.kt)("h4",{id:"defined-in-96"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L165"},"packages/core/src/react/components/BlocksRenderer.tsx:165")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"htmldecoder"},"HtmlDecoder"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"HtmlDecoder"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"context?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"HtmlDecoder")," simply decodes html entities"),(0,r.kt)("p",null,"Any actual html markup gets stripped before decoding html entities. If you need to render HTML use ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#safehtml"},"SafeHtml")),(0,r.kt)("h4",{id:"usage-2"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},'\n')),(0,r.kt)("h4",{id:"parameters-69"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"PropsWithChildren"),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.HtmlDecodeProps"},(0,r.kt)("inlineCode",{parentName:"a"},"HtmlDecodeProps")),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component properties")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"context?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-73"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-97"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/react/index.d.ts:542"),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"safehtml"},"SafeHtml"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"SafeHtml"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"props"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"context?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"SafeHtml")," component provides an easy way to safely render HTML"),(0,r.kt)("p",null,"The html prop is sanitized through ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#wpksespost"},"wpKsesPost")," so it's safe for rendering arbitrary html markup."),(0,r.kt)("h4",{id:"usage-3"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-jsx"},'\n')),(0,r.kt)("h4",{id:"parameters-70"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"PropsWithChildren"),"<",(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.SafeHtmlProps"},(0,r.kt)("inlineCode",{parentName:"a"},"SafeHtmlProps")),">"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Component properties")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"context?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"any")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-74"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-98"},"Defined in"),(0,r.kt)("p",null,"node_modules/@types/react/index.d.ts:542"))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4727697a.b8e703ec.js b/assets/js/4727697a.41467c88.js similarity index 90% rename from assets/js/4727697a.b8e703ec.js rename to assets/js/4727697a.41467c88.js index cbebf2252..bb0f9bbaa 100644 --- a/assets/js/4727697a.b8e703ec.js +++ b/assets/js/4727697a.41467c88.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2354],{3905:(e,t,a)=>{a.d(t,{Zo:()=>l,kt:()=>f});var n=a(7294);function i(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function d(e){for(var t=1;t=0||(i[a]=e[a]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var s=n.createContext({}),o=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):d(d({},t),e)),a},l=function(e){var t=o(e.components);return n.createElement(s.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,l=p(e,["components","mdxType","originalType","parentName"]),c=o(a),k=i,f=c["".concat(s,".").concat(k)]||c[k]||h[k]||r;return a?n.createElement(f,d(d({ref:t},l),{},{components:a})):n.createElement(f,d({ref:t},l))}));function f(e,t){var a=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=a.length,d=new Array(r);d[0]=k;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[c]="string"==typeof e?e:i,d[1]=p;for(var o=2;o{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>d,default:()=>c,frontMatter:()=>r,metadata:()=>p,toc:()=>o});var n=a(7462),i=(a(7294),a(3905));const r={id:"headstartwp_core.RevisionEntity",title:"Interface: RevisionEntity",sidebar_label:"@headstartwp/core.RevisionEntity",custom_edit_url:null},d=void 0,p={unversionedId:"interfaces/headstartwp_core.RevisionEntity",id:"interfaces/headstartwp_core.RevisionEntity",title:"Interface: RevisionEntity",description:"@headstartwp/core.RevisionEntity",source:"@site/docs/interfaces/headstartwp_core.RevisionEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.RevisionEntity",permalink:"/docs/api/interfaces/headstartwp_core.RevisionEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.RevisionEntity",title:"Interface: RevisionEntity",sidebar_label:"@headstartwp/core.RevisionEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.Rendered",permalink:"/docs/api/interfaces/headstartwp_core.Rendered"},next:{title:"@headstartwp/core.SearchEntity",permalink:"/docs/api/interfaces/headstartwp_core.SearchEntity"}},s={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embedded",id:"_embedded",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"author",id:"author",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"comment_status",id:"comment_status",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"content",id:"content",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"date",id:"date",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"date_gmt",id:"date_gmt",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"excerpt",id:"excerpt",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"guid",id:"guid",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"link",id:"link",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"modified",id:"modified",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"modified_gmt",id:"modified_gmt",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"parent",id:"parent",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"ping_status",id:"ping_status",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"slug",id:"slug",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"status",id:"status",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"terms",id:"terms",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"type",id:"type",level:3},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-20",level:4}],l={toc:o};function c(e){let{components:t,...a}=e;return(0,i.kt)("wrapper",(0,n.Z)({},l,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".RevisionEntity"),(0,i.kt)("p",null,"Interface for entities from the /wp/v2/posts/1/revisions endpoint."),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"PostTypeEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"RevisionEntity"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"_embedded"},"_","embedded"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"_","embedded"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"author")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wp:term")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]")))),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#_embedded"},"_embedded")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L98"},"packages/core/src/data/types/entities.ts:98")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"author"},"author"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"author"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#author"},"author")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L94"},"packages/core/src/data/types/entities.ts:94")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"comment_status"},"comment","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"comment","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not comments are open on the object."),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#comment_status"},"comment_status")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L106"},"packages/core/src/data/types/entities.ts:106")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"content"},"content"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"content"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The content for the object."),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L189"},"packages/core/src/data/types/entities.ts:189")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date"},"date"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date"},"date")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L42"},"packages/core/src/data/types/entities.ts:42")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date_gmt"},"date","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, as GMT."),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date_gmt"},"date_gmt")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L47"},"packages/core/src/data/types/entities.ts:47")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"excerpt"},"excerpt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"excerpt"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The excerpt for the object."),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L194"},"packages/core/src/data/types/entities.ts:194")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"guid"},"guid"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"guid"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The globally unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#guid"},"guid")),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L52"},"packages/core/src/data/types/entities.ts:52")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"id"},"id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#id"},"id")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L67"},"packages/core/src/data/types/entities.ts:67")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"link"},"link"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"link"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"URL to the object."),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#link"},"link")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L72"},"packages/core/src/data/types/entities.ts:72")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified"},"modified"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified"},"modified")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L57"},"packages/core/src/data/types/entities.ts:57")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified_gmt"},"modified","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, as GMT."),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified_gmt"},"modified_gmt")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L62"},"packages/core/src/data/types/entities.ts:62")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"parent"},"parent"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"parent"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The ID for the parent of the object."),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L184"},"packages/core/src/data/types/entities.ts:184")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ping_status"},"ping","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ping","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not the object can be pinged."),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#ping_status"},"ping_status")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L111"},"packages/core/src/data/types/entities.ts:111")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"slug"},"slug"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"slug"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"An alphanumeric identifier for the object unique to its type."),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#slug"},"slug")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L77"},"packages/core/src/data/types/entities.ts:77")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"status"},"status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"publish"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"future"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"draft"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"pending"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"private"')),(0,i.kt)("p",null,"A named status for the object."),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#status"},"status")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L82"},"packages/core/src/data/types/entities.ts:82")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"terms"},"terms"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"terms"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,i.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#terms"},"terms")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L96"},"packages/core/src/data/types/entities.ts:96")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The title for the object."),(0,i.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#title"},"title")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L92"},"packages/core/src/data/types/entities.ts:92")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"type"},"type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Type of Post for the object."),(0,i.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#type"},"type")),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L87"},"packages/core/src/data/types/entities.ts:87")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head"},"yoast_head")),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L114"},"packages/core/src/data/types/entities.ts:114")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head_json"},"yoast_head_json")),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L113"},"packages/core/src/data/types/entities.ts:113")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2354],{3905:(e,t,a)=>{a.d(t,{Zo:()=>l,kt:()=>f});var n=a(7294);function i(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(i[a]=e[a]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var s=n.createContext({}),o=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},l=function(e){var t=o(e.components);return n.createElement(s.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,l=d(e,["components","mdxType","originalType","parentName"]),c=o(a),k=i,f=c["".concat(s,".").concat(k)]||c[k]||h[k]||r;return a?n.createElement(f,p(p({ref:t},l),{},{components:a})):n.createElement(f,p({ref:t},l))}));function f(e,t){var a=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=a.length,p=new Array(r);p[0]=k;var d={};for(var s in t)hasOwnProperty.call(t,s)&&(d[s]=t[s]);d.originalType=e,d[c]="string"==typeof e?e:i,p[1]=d;for(var o=2;o{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>c,frontMatter:()=>r,metadata:()=>d,toc:()=>o});var n=a(7462),i=(a(7294),a(3905));const r={id:"headstartwp_core.RevisionEntity",title:"Interface: RevisionEntity",sidebar_label:"@headstartwp/core.RevisionEntity",custom_edit_url:null},p=void 0,d={unversionedId:"interfaces/headstartwp_core.RevisionEntity",id:"interfaces/headstartwp_core.RevisionEntity",title:"Interface: RevisionEntity",description:"@headstartwp/core.RevisionEntity",source:"@site/docs/interfaces/headstartwp_core.RevisionEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.RevisionEntity",permalink:"/docs/api/interfaces/headstartwp_core.RevisionEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.RevisionEntity",title:"Interface: RevisionEntity",sidebar_label:"@headstartwp/core.RevisionEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.Rendered",permalink:"/docs/api/interfaces/headstartwp_core.Rendered"},next:{title:"@headstartwp/core.SearchEntity",permalink:"/docs/api/interfaces/headstartwp_core.SearchEntity"}},s={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embedded",id:"_embedded",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"author",id:"author",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"comment_status",id:"comment_status",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"content",id:"content",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"date",id:"date",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"date_gmt",id:"date_gmt",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"excerpt",id:"excerpt",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"guid",id:"guid",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"link",id:"link",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"modified",id:"modified",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"modified_gmt",id:"modified_gmt",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"parent",id:"parent",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"ping_status",id:"ping_status",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"slug",id:"slug",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"status",id:"status",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"terms",id:"terms",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"type",id:"type",level:3},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-20",level:4}],l={toc:o};function c(e){let{components:t,...a}=e;return(0,i.kt)("wrapper",(0,n.Z)({},l,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".RevisionEntity"),(0,i.kt)("p",null,"Interface for entities from the /wp/v2/posts/1/revisions endpoint."),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"PostTypeEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"RevisionEntity"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"_embedded"},"_","embedded"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"_","embedded"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"author")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wp:term")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]")))),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#_embedded"},"_embedded")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L98"},"packages/core/src/data/types/entities.ts:98")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"author"},"author"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"author"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#author"},"author")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L94"},"packages/core/src/data/types/entities.ts:94")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"comment_status"},"comment","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"comment","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not comments are open on the object."),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#comment_status"},"comment_status")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L106"},"packages/core/src/data/types/entities.ts:106")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"content"},"content"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"content"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The content for the object."),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L189"},"packages/core/src/data/types/entities.ts:189")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date"},"date"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date"},"date")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L42"},"packages/core/src/data/types/entities.ts:42")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date_gmt"},"date","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, as GMT."),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date_gmt"},"date_gmt")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L47"},"packages/core/src/data/types/entities.ts:47")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"excerpt"},"excerpt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"excerpt"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The excerpt for the object."),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L194"},"packages/core/src/data/types/entities.ts:194")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"guid"},"guid"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"guid"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The globally unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#guid"},"guid")),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L52"},"packages/core/src/data/types/entities.ts:52")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"id"},"id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#id"},"id")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L67"},"packages/core/src/data/types/entities.ts:67")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"link"},"link"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"link"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"URL to the object."),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#link"},"link")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L72"},"packages/core/src/data/types/entities.ts:72")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified"},"modified"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified"},"modified")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L57"},"packages/core/src/data/types/entities.ts:57")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified_gmt"},"modified","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, as GMT."),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified_gmt"},"modified_gmt")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L62"},"packages/core/src/data/types/entities.ts:62")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"parent"},"parent"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"parent"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The ID for the parent of the object."),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L184"},"packages/core/src/data/types/entities.ts:184")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ping_status"},"ping","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ping","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not the object can be pinged."),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#ping_status"},"ping_status")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L111"},"packages/core/src/data/types/entities.ts:111")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"slug"},"slug"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"slug"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"An alphanumeric identifier for the object unique to its type."),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#slug"},"slug")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L77"},"packages/core/src/data/types/entities.ts:77")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"status"},"status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"publish"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"future"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"draft"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"pending"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"private"')),(0,i.kt)("p",null,"A named status for the object."),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#status"},"status")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L82"},"packages/core/src/data/types/entities.ts:82")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"terms"},"terms"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"terms"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,i.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#terms"},"terms")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L96"},"packages/core/src/data/types/entities.ts:96")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The title for the object."),(0,i.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#title"},"title")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L92"},"packages/core/src/data/types/entities.ts:92")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"type"},"type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Type of Post for the object."),(0,i.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#type"},"type")),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L87"},"packages/core/src/data/types/entities.ts:87")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head"},"yoast_head")),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L114"},"packages/core/src/data/types/entities.ts:114")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head_json"},"yoast_head_json")),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L113"},"packages/core/src/data/types/entities.ts:113")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4917042f.2985d762.js b/assets/js/4917042f.369f0e56.js similarity index 86% rename from assets/js/4917042f.2985d762.js rename to assets/js/4917042f.369f0e56.js index 657f5bea6..c57d75cc0 100644 --- a/assets/js/4917042f.2985d762.js +++ b/assets/js/4917042f.369f0e56.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6217],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),d=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},l=function(e){var t=d(e.components);return a.createElement(p.Provider,{value:t},e.children)},c="mdxType",f={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),c=d(r),m=n,h=c["".concat(p,".").concat(m)]||c[m]||f[m]||i;return r?a.createElement(h,o(o({ref:t},l),{},{components:r})):a.createElement(h,o({ref:t},l))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=m;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s[c]="string"==typeof e?e:n,o[1]=s;for(var d=2;d{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.VerifyTokenParams",title:"Interface: VerifyTokenParams",sidebar_label:"@headstartwp/core.VerifyTokenParams",custom_edit_url:null},o=void 0,s={unversionedId:"interfaces/headstartwp_core.VerifyTokenParams",id:"interfaces/headstartwp_core.VerifyTokenParams",title:"Interface: VerifyTokenParams",description:"@headstartwp/core.VerifyTokenParams",source:"@site/docs/interfaces/headstartwp_core.VerifyTokenParams.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.VerifyTokenParams",permalink:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.VerifyTokenParams",title:"Interface: VerifyTokenParams",sidebar_label:"@headstartwp/core.VerifyTokenParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.TypeEntity",permalink:"/docs/api/interfaces/headstartwp_core.TypeEntity"},next:{title:"@headstartwp/core.YoastSEOIntegration",permalink:"/docs/api/interfaces/headstartwp_core.YoastSEOIntegration"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embed",id:"_embed",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"_fields",id:"_fields",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"authToken",id:"authtoken",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"lang",id:"lang",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],l={toc:d};function c(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".VerifyTokenParams"),(0,n.kt)("p",null,"The EndpointParams supported by the ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy"},"VerifyTokenFetchStrategy")),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"VerifyTokenParams"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"_embed"},"_","embed"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","embed"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"The _embed param returned associated entities in the response"),(0,n.kt)("p",null,"It's recommended to avoid additional requests to fetch data"),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_embed"},"_embed")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L17"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:17")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"_fields"},"_","fields"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","fields"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The _fields parameter is used to return only the specified fields in the response"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_fields"},"_fields")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L22"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:22")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"authtoken"},"authToken"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"authToken"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts#L9"},"packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:9")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"lang"},"lang"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"lang"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The polylang ?lang parameter."),(0,n.kt)("p",null,"This is only used if the polylang integration is enabled"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#lang"},"lang")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L29"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:29")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6217],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),l=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},d=function(e){var t=l(e.components);return a.createElement(p.Provider,{value:t},e.children)},c="mdxType",f={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),c=l(r),m=n,h=c["".concat(p,".").concat(m)]||c[m]||f[m]||i;return r?a.createElement(h,o(o({ref:t},d),{},{components:r})):a.createElement(h,o({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=m;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s[c]="string"==typeof e?e:n,o[1]=s;for(var l=2;l{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.VerifyTokenParams",title:"Interface: VerifyTokenParams",sidebar_label:"@headstartwp/core.VerifyTokenParams",custom_edit_url:null},o=void 0,s={unversionedId:"interfaces/headstartwp_core.VerifyTokenParams",id:"interfaces/headstartwp_core.VerifyTokenParams",title:"Interface: VerifyTokenParams",description:"@headstartwp/core.VerifyTokenParams",source:"@site/docs/interfaces/headstartwp_core.VerifyTokenParams.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.VerifyTokenParams",permalink:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.VerifyTokenParams",title:"Interface: VerifyTokenParams",sidebar_label:"@headstartwp/core.VerifyTokenParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.TypeEntity",permalink:"/docs/api/interfaces/headstartwp_core.TypeEntity"},next:{title:"@headstartwp/core.YoastSEOIntegration",permalink:"/docs/api/interfaces/headstartwp_core.YoastSEOIntegration"}},p={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embed",id:"_embed",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"_fields",id:"_fields",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"authToken",id:"authtoken",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"lang",id:"lang",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],d={toc:l};function c(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".VerifyTokenParams"),(0,n.kt)("p",null,"The EndpointParams supported by the ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy"},"VerifyTokenFetchStrategy")),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"VerifyTokenParams"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"_embed"},"_","embed"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","embed"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"The _embed param returned associated entities in the response"),(0,n.kt)("p",null,"It's recommended to avoid additional requests to fetch data"),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_embed"},"_embed")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L17"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:17")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"_fields"},"_","fields"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","fields"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The _fields parameter is used to return only the specified fields in the response"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_fields"},"_fields")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L22"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:22")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"authtoken"},"authToken"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"authToken"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts#L9"},"packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:9")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"lang"},"lang"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"lang"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The polylang ?lang parameter."),(0,n.kt)("p",null,"This is only used if the polylang integration is enabled"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#lang"},"lang")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L29"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:29")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/499cbdae.77d89bdb.js b/assets/js/499cbdae.919ba76b.js similarity index 96% rename from assets/js/499cbdae.77d89bdb.js rename to assets/js/499cbdae.919ba76b.js index 83bff2103..56b37d04a 100644 --- a/assets/js/499cbdae.77d89bdb.js +++ b/assets/js/499cbdae.919ba76b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2089],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>f});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=n.createContext({}),s=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},l=function(e){var t=s(e.components);return n.createElement(p.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},y=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,p=e.parentName,l=c(e,["components","mdxType","originalType","parentName"]),u=s(r),y=a,f=u["".concat(p,".").concat(y)]||u[y]||d[y]||o;return r?n.createElement(f,i(i({ref:t},l),{},{components:r})):n.createElement(f,i({ref:t},l))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=y;var c={};for(var p in t)hasOwnProperty.call(t,p)&&(c[p]=t[p]);c.originalType=e,c[u]="string"==typeof e?e:a,i[1]=c;for(var s=2;s{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>s});var n=r(7462),a=(r(7294),r(3905));const o={sidebar_label:"TypeScript"},i="TypeScript",c={unversionedId:"Guides/typescript",id:"Guides/typescript",title:"TypeScript",description:"",source:"@site/documentation/08-Guides/typescript.md",sourceDirName:"08-Guides",slug:"/Guides/typescript",permalink:"/docs/learn/Guides/typescript",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/08-Guides/typescript.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",frontMatter:{sidebar_label:"TypeScript"},sidebar:"tutorialSidebar",previous:{title:"Linaria (CSS-in-JS)",permalink:"/docs/learn/Guides/linaria"},next:{title:"Implementing a Youtube Facade",permalink:"/docs/learn/Guides/youtube-facade"}},p={},s=[],l={toc:s};function u(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"typescript"},"TypeScript"))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2089],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>f});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=n.createContext({}),s=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},l=function(e){var t=s(e.components);return n.createElement(p.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},y=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,p=e.parentName,l=c(e,["components","mdxType","originalType","parentName"]),u=s(r),y=a,f=u["".concat(p,".").concat(y)]||u[y]||d[y]||o;return r?n.createElement(f,i(i({ref:t},l),{},{components:r})):n.createElement(f,i({ref:t},l))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=y;var c={};for(var p in t)hasOwnProperty.call(t,p)&&(c[p]=t[p]);c.originalType=e,c[u]="string"==typeof e?e:a,i[1]=c;for(var s=2;s{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>c,toc:()=>s});var n=r(7462),a=(r(7294),r(3905));const o={sidebar_label:"TypeScript"},i="TypeScript",c={unversionedId:"Guides/typescript",id:"Guides/typescript",title:"TypeScript",description:"",source:"@site/documentation/08-Guides/typescript.md",sourceDirName:"08-Guides",slug:"/Guides/typescript",permalink:"/docs/learn/Guides/typescript",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/08-Guides/typescript.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",frontMatter:{sidebar_label:"TypeScript"},sidebar:"tutorialSidebar",previous:{title:"Linaria (CSS-in-JS)",permalink:"/docs/learn/Guides/linaria"},next:{title:"Implementing a Youtube Facade",permalink:"/docs/learn/Guides/youtube-facade"}},p={},s=[],l={toc:s};function u(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"typescript"},"TypeScript"))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/49db3b24.203349d7.js b/assets/js/49db3b24.e14d0667.js similarity index 83% rename from assets/js/49db3b24.203349d7.js rename to assets/js/49db3b24.e14d0667.js index c4563c215..f6cbd65c1 100644 --- a/assets/js/49db3b24.203349d7.js +++ b/assets/js/49db3b24.e14d0667.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5281],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>u});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function l(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(r),h=n,u=s["".concat(p,".").concat(h)]||s[h]||k[h]||l;return r?a.createElement(u,i(i({ref:t},d),{},{components:r})):a.createElement(u,i({ref:t},d))}));function u(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=r.length,i=new Array(l);i[0]=h;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const l={id:"headstartwp_core.react.ButtonBlockProps",title:"Interface: ButtonBlockProps",sidebar_label:"@headstartwp/core.react.ButtonBlockProps",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.ButtonBlockProps",id:"interfaces/headstartwp_core.react.ButtonBlockProps",title:"Interface: ButtonBlockProps",description:"@headstartwp/core.react.ButtonBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.ButtonBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ButtonBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ButtonBlockProps",title:"Interface: ButtonBlockProps",sidebar_label:"@headstartwp/core.react.ButtonBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.BlockRendererProps",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockRendererProps"},next:{title:"@headstartwp/core.react.ButtonsBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"linkTarget",id:"linktarget",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"placeholder",id:"placeholder",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"rel",id:"rel",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"text",id:"text",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-12",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ButtonBlockProps"),(0,n.kt)("p",null,"The interface for components rendered by ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#buttonblock"},"ButtonBlock")),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ButtonBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"linktarget"},"linkTarget"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"linkTarget"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The link target"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/ButtonBlock.tsx#L31"},"packages/core/src/react/blocks/ButtonBlock.tsx:31")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"placeholder"},"placeholder"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"placeholder"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The link placeholder text"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/ButtonBlock.tsx#L41"},"packages/core/src/react/blocks/ButtonBlock.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"rel"},"rel"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"rel"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The link rel"),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/ButtonBlock.tsx#L36"},"packages/core/src/react/blocks/ButtonBlock.tsx:36")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"text"},"text"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"text"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The button text"),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/ButtonBlock.tsx#L26"},"packages/core/src/react/blocks/ButtonBlock.tsx:26")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"title"},"title"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"title"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The title of the link"),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/ButtonBlock.tsx#L21"},"packages/core/src/react/blocks/ButtonBlock.tsx:21")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"url"},"url"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"url"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The button url"),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/ButtonBlock.tsx#L16"},"packages/core/src/react/blocks/ButtonBlock.tsx:16")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5281],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>u});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),h=n,u=s["".concat(p,".").concat(h)]||s[h]||k[h]||l;return a?r.createElement(u,i(i({ref:t},d),{},{components:a})):r.createElement(u,i({ref:t},d))}));function u(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,i=new Array(l);i[0]=h;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.ButtonBlockProps",title:"Interface: ButtonBlockProps",sidebar_label:"@headstartwp/core.react.ButtonBlockProps",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.ButtonBlockProps",id:"interfaces/headstartwp_core.react.ButtonBlockProps",title:"Interface: ButtonBlockProps",description:"@headstartwp/core.react.ButtonBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.ButtonBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ButtonBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ButtonBlockProps",title:"Interface: ButtonBlockProps",sidebar_label:"@headstartwp/core.react.ButtonBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.BlockRendererProps",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockRendererProps"},next:{title:"@headstartwp/core.react.ButtonsBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"linkTarget",id:"linktarget",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"placeholder",id:"placeholder",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"rel",id:"rel",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"text",id:"text",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-12",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ButtonBlockProps"),(0,n.kt)("p",null,"The interface for components rendered by ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#buttonblock"},"ButtonBlock")),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ButtonBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"linktarget"},"linkTarget"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"linkTarget"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The link target"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/ButtonBlock.tsx#L31"},"packages/core/src/react/blocks/ButtonBlock.tsx:31")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"placeholder"},"placeholder"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"placeholder"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The link placeholder text"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/ButtonBlock.tsx#L41"},"packages/core/src/react/blocks/ButtonBlock.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"rel"},"rel"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"rel"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The link rel"),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/ButtonBlock.tsx#L36"},"packages/core/src/react/blocks/ButtonBlock.tsx:36")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"text"},"text"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"text"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The button text"),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/ButtonBlock.tsx#L26"},"packages/core/src/react/blocks/ButtonBlock.tsx:26")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"title"},"title"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"title"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The title of the link"),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/ButtonBlock.tsx#L21"},"packages/core/src/react/blocks/ButtonBlock.tsx:21")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"url"},"url"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"url"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The button url"),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/ButtonBlock.tsx#L16"},"packages/core/src/react/blocks/ButtonBlock.tsx:16")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4a0d0a3d.2035cbc6.js b/assets/js/4a0d0a3d.aa545fd8.js similarity index 90% rename from assets/js/4a0d0a3d.2035cbc6.js rename to assets/js/4a0d0a3d.aa545fd8.js index 5d67b56a2..fe9b6a420 100644 --- a/assets/js/4a0d0a3d.2035cbc6.js +++ b/assets/js/4a0d0a3d.aa545fd8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8950],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(r),u=n,m=s["".concat(p,".").concat(u)]||s[u]||k[u]||i;return r?a.createElement(m,l(l({ref:t},d),{},{components:r})):a.createElement(m,l({ref:t},d))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=u;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,l[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.YoutubeLiteBlockProps",title:"Interface: YoutubeLiteBlockProps",sidebar_label:"@headstartwp/core.react.YoutubeLiteBlockProps",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.YoutubeLiteBlockProps",id:"interfaces/headstartwp_core.react.YoutubeLiteBlockProps",title:"Interface: YoutubeLiteBlockProps",description:"@headstartwp/core.react.YoutubeLiteBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.YoutubeLiteBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.YoutubeLiteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.YoutubeLiteBlockProps",title:"Interface: YoutubeLiteBlockProps",sidebar_label:"@headstartwp/core.react.YoutubeLiteBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.WpThemeJSON",permalink:"/docs/api/interfaces/headstartwp_core.react.WpThemeJSON"},next:{title:"@headstartwp/core.react.useAppSettingsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"src",id:"src",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-8",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".YoutubeLiteBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"YoutubeLiteBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"src"},"src"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"src"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/YoutubeLiteBlock.tsx#L29"},"packages/core/src/react/blocks/YoutubeLiteBlock.tsx:29")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"title"},"title"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"title"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/YoutubeLiteBlock.tsx#L30"},"packages/core/src/react/blocks/YoutubeLiteBlock.tsx:30")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8950],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),d=c(r),u=n,m=d["".concat(p,".").concat(u)]||d[u]||k[u]||i;return r?a.createElement(m,l(l({ref:t},s),{},{components:r})):a.createElement(m,l({ref:t},s))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=u;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[d]="string"==typeof e?e:n,l[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.YoutubeLiteBlockProps",title:"Interface: YoutubeLiteBlockProps",sidebar_label:"@headstartwp/core.react.YoutubeLiteBlockProps",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.YoutubeLiteBlockProps",id:"interfaces/headstartwp_core.react.YoutubeLiteBlockProps",title:"Interface: YoutubeLiteBlockProps",description:"@headstartwp/core.react.YoutubeLiteBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.YoutubeLiteBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.YoutubeLiteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.YoutubeLiteBlockProps",title:"Interface: YoutubeLiteBlockProps",sidebar_label:"@headstartwp/core.react.YoutubeLiteBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.WpThemeJSON",permalink:"/docs/api/interfaces/headstartwp_core.react.WpThemeJSON"},next:{title:"@headstartwp/core.react.useAppSettingsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"src",id:"src",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-8",level:4}],s={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".YoutubeLiteBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"YoutubeLiteBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"src"},"src"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"src"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/YoutubeLiteBlock.tsx#L29"},"packages/core/src/react/blocks/YoutubeLiteBlock.tsx:29")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"title"},"title"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"title"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/YoutubeLiteBlock.tsx#L30"},"packages/core/src/react/blocks/YoutubeLiteBlock.tsx:30")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4a5e8971.d9cfd167.js b/assets/js/4a5e8971.dfcfe5b3.js similarity index 96% rename from assets/js/4a5e8971.d9cfd167.js rename to assets/js/4a5e8971.dfcfe5b3.js index 01be76191..c36d4d98f 100644 --- a/assets/js/4a5e8971.d9cfd167.js +++ b/assets/js/4a5e8971.dfcfe5b3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5534],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function p(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function o(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var l=r.createContext({}),c=function(e){var t=r.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},s=function(e){var t=c(e.components);return r.createElement(l.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,p=e.originalType,l=e.parentName,s=i(e,["components","mdxType","originalType","parentName"]),d=c(a),m=n,h=d["".concat(l,".").concat(m)]||d[m]||k[m]||p;return a?r.createElement(h,o(o({ref:t},s),{},{components:a})):r.createElement(h,o({ref:t},s))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var p=a.length,o=new Array(p);o[0]=m;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[d]="string"==typeof e?e:n,o[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>d,frontMatter:()=>p,metadata:()=>i,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const p={id:"headstartwp_core.react.IBlockAttributes",title:"Interface: IBlockAttributes",sidebar_label:"@headstartwp/core.react.IBlockAttributes",custom_edit_url:null},o=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IBlockAttributes",id:"interfaces/headstartwp_core.react.IBlockAttributes",title:"Interface: IBlockAttributes",description:"@headstartwp/core.react.IBlockAttributes",source:"@site/docs/interfaces/headstartwp_core.react.IBlockAttributes.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IBlockAttributes",permalink:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IBlockAttributes",title:"Interface: IBlockAttributes",sidebar_label:"@headstartwp/core.react.IBlockAttributes",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IBlock"},next:{title:"@headstartwp/core.react.IButtonBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IButtonBlock"}},l={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Defined in",id:"defined-in-6",level:4}],s={toc:c};function d(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IBlockAttributes"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ButtonBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ButtonsBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"AudioBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CodeBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ColumnsBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ColumnBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CoverBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ParagraphBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadingBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"QuoteBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PullQuoteBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PreformattedBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"VerseBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"TableBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"GroupBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SeparatorBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SpacerBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ListBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"YoutubeLiteBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"FileBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"MediaTextBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ImageBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5534],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function p(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function o(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var l=r.createContext({}),c=function(e){var t=r.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},s=function(e){var t=c(e.components);return r.createElement(l.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,p=e.originalType,l=e.parentName,s=i(e,["components","mdxType","originalType","parentName"]),d=c(a),m=n,h=d["".concat(l,".").concat(m)]||d[m]||k[m]||p;return a?r.createElement(h,o(o({ref:t},s),{},{components:a})):r.createElement(h,o({ref:t},s))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var p=a.length,o=new Array(p);o[0]=m;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[d]="string"==typeof e?e:n,o[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>d,frontMatter:()=>p,metadata:()=>i,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const p={id:"headstartwp_core.react.IBlockAttributes",title:"Interface: IBlockAttributes",sidebar_label:"@headstartwp/core.react.IBlockAttributes",custom_edit_url:null},o=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IBlockAttributes",id:"interfaces/headstartwp_core.react.IBlockAttributes",title:"Interface: IBlockAttributes",description:"@headstartwp/core.react.IBlockAttributes",source:"@site/docs/interfaces/headstartwp_core.react.IBlockAttributes.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IBlockAttributes",permalink:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IBlockAttributes",title:"Interface: IBlockAttributes",sidebar_label:"@headstartwp/core.react.IBlockAttributes",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IBlock"},next:{title:"@headstartwp/core.react.IButtonBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IButtonBlock"}},l={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Defined in",id:"defined-in-6",level:4}],s={toc:c};function d(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IBlockAttributes"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ButtonBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ButtonsBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"AudioBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CodeBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ColumnsBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ColumnBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CoverBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ParagraphBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadingBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"QuoteBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PullQuoteBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PreformattedBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"VerseBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"TableBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"GroupBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SeparatorBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SpacerBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ListBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"YoutubeLiteBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"FileBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"MediaTextBlockProps"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ImageBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4bbbe9cb.3cfb3d6d.js b/assets/js/4bbbe9cb.9abc4d6a.js similarity index 97% rename from assets/js/4bbbe9cb.3cfb3d6d.js rename to assets/js/4bbbe9cb.9abc4d6a.js index 1c9c9fdab..c95e6f421 100644 --- a/assets/js/4bbbe9cb.3cfb3d6d.js +++ b/assets/js/4bbbe9cb.9abc4d6a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8327],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||o;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,l=new Array(o);l[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:n,l[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.IGroupBlock",title:"Interface: IGroupBlock",sidebar_label:"@headstartwp/core.react.IGroupBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IGroupBlock",id:"interfaces/headstartwp_core.react.IGroupBlock",title:"Interface: IGroupBlock",description:"@headstartwp/core.react.IGroupBlock",source:"@site/docs/interfaces/headstartwp_core.react.IGroupBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IGroupBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IGroupBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IGroupBlock",title:"Interface: IGroupBlock",sidebar_label:"@headstartwp/core.react.IGroupBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IFileBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IFileBlock"},next:{title:"@headstartwp/core.react.IHeadingBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IHeadingBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IGroupBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"GroupBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IGroupBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"GroupBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"GroupBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8327],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||o;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,l=new Array(o);l[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:n,l[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.IGroupBlock",title:"Interface: IGroupBlock",sidebar_label:"@headstartwp/core.react.IGroupBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IGroupBlock",id:"interfaces/headstartwp_core.react.IGroupBlock",title:"Interface: IGroupBlock",description:"@headstartwp/core.react.IGroupBlock",source:"@site/docs/interfaces/headstartwp_core.react.IGroupBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IGroupBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IGroupBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IGroupBlock",title:"Interface: IGroupBlock",sidebar_label:"@headstartwp/core.react.IGroupBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IFileBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IFileBlock"},next:{title:"@headstartwp/core.react.IHeadingBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IHeadingBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IGroupBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"GroupBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IGroupBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"GroupBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"GroupBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4bc3bdcd.8fcec4e5.js b/assets/js/4bc3bdcd.e78fe72c.js similarity index 95% rename from assets/js/4bc3bdcd.8fcec4e5.js rename to assets/js/4bc3bdcd.e78fe72c.js index 637cb964e..bb0ceca88 100644 --- a/assets/js/4bc3bdcd.8fcec4e5.js +++ b/assets/js/4bc3bdcd.e78fe72c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9921],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>f});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),l=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},d=function(e){var t=l(e.components);return r.createElement(o.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),c=l(a),u=n,f=c["".concat(o,".").concat(u)]||c[u]||m[u]||i;return a?r.createElement(f,p(p({ref:t},d),{},{components:a})):r.createElement(f,p({ref:t},d))}));function f(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=u;var s={};for(var o in t)hasOwnProperty.call(t,o)&&(s[o]=t[o]);s.originalType=e,s[c]="string"==typeof e?e:n,p[1]=s;for(var l=2;l{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.EndpointParams",title:"Interface: EndpointParams",sidebar_label:"@headstartwp/core.EndpointParams",custom_edit_url:null},p=void 0,s={unversionedId:"interfaces/headstartwp_core.EndpointParams",id:"interfaces/headstartwp_core.EndpointParams",title:"Interface: EndpointParams",description:"@headstartwp/core.EndpointParams",source:"@site/docs/interfaces/headstartwp_core.EndpointParams.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.EndpointParams",permalink:"/docs/api/interfaces/headstartwp_core.EndpointParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.EndpointParams",title:"Interface: EndpointParams",sidebar_label:"@headstartwp/core.EndpointParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.CommentEntity",permalink:"/docs/api/interfaces/headstartwp_core.CommentEntity"},next:{title:"@headstartwp/core.Entity",permalink:"/docs/api/interfaces/headstartwp_core.Entity"}},o={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"_embed",id:"_embed",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"_fields",id:"_fields",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"lang",id:"lang",level:3},{value:"Defined in",id:"defined-in-2",level:4}],d={toc:l};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".EndpointParams"),(0,n.kt)("p",null,"The base interface for defining endpoint parameters"),(0,n.kt)("p",null,"Strategies should define type with the actually supported EndPointParams"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"EndpointParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchParams"},(0,n.kt)("inlineCode",{parentName:"a"},"SearchParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"TaxonomyArchiveParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams"},(0,n.kt)("inlineCode",{parentName:"a"},"VerifyTokenParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsParams"))))),(0,n.kt)("h2",{id:"indexable"},"Indexable"),(0,n.kt)("p",null,"\u25aa ","[k: ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"_embed"},"_","embed"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","embed"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"The _embed param returned associated entities in the response"),(0,n.kt)("p",null,"It's recommended to avoid additional requests to fetch data"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L17"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:17")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"_fields"},"_","fields"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","fields"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The _fields parameter is used to return only the specified fields in the response"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L22"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:22")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"lang"},"lang"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"lang"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The polylang ?lang parameter."),(0,n.kt)("p",null,"This is only used if the polylang integration is enabled"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L29"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:29")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9921],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>f});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),l=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},d=function(e){var t=l(e.components);return r.createElement(o.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),c=l(a),u=n,f=c["".concat(o,".").concat(u)]||c[u]||m[u]||i;return a?r.createElement(f,p(p({ref:t},d),{},{components:a})):r.createElement(f,p({ref:t},d))}));function f(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=u;var s={};for(var o in t)hasOwnProperty.call(t,o)&&(s[o]=t[o]);s.originalType=e,s[c]="string"==typeof e?e:n,p[1]=s;for(var l=2;l{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.EndpointParams",title:"Interface: EndpointParams",sidebar_label:"@headstartwp/core.EndpointParams",custom_edit_url:null},p=void 0,s={unversionedId:"interfaces/headstartwp_core.EndpointParams",id:"interfaces/headstartwp_core.EndpointParams",title:"Interface: EndpointParams",description:"@headstartwp/core.EndpointParams",source:"@site/docs/interfaces/headstartwp_core.EndpointParams.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.EndpointParams",permalink:"/docs/api/interfaces/headstartwp_core.EndpointParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.EndpointParams",title:"Interface: EndpointParams",sidebar_label:"@headstartwp/core.EndpointParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.CommentEntity",permalink:"/docs/api/interfaces/headstartwp_core.CommentEntity"},next:{title:"@headstartwp/core.Entity",permalink:"/docs/api/interfaces/headstartwp_core.Entity"}},o={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"_embed",id:"_embed",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"_fields",id:"_fields",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"lang",id:"lang",level:3},{value:"Defined in",id:"defined-in-2",level:4}],d={toc:l};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".EndpointParams"),(0,n.kt)("p",null,"The base interface for defining endpoint parameters"),(0,n.kt)("p",null,"Strategies should define type with the actually supported EndPointParams"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"EndpointParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchParams"},(0,n.kt)("inlineCode",{parentName:"a"},"SearchParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"TaxonomyArchiveParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams"},(0,n.kt)("inlineCode",{parentName:"a"},"VerifyTokenParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsParams"))))),(0,n.kt)("h2",{id:"indexable"},"Indexable"),(0,n.kt)("p",null,"\u25aa ","[k: ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"_embed"},"_","embed"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","embed"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"The _embed param returned associated entities in the response"),(0,n.kt)("p",null,"It's recommended to avoid additional requests to fetch data"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L17"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:17")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"_fields"},"_","fields"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","fields"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The _fields parameter is used to return only the specified fields in the response"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L22"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:22")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"lang"},"lang"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"lang"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The polylang ?lang parameter."),(0,n.kt)("p",null,"This is only used if the polylang integration is enabled"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L29"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:29")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4bfc8e71.2e3e19e2.js b/assets/js/4bfc8e71.03baac51.js similarity index 98% rename from assets/js/4bfc8e71.2e3e19e2.js rename to assets/js/4bfc8e71.03baac51.js index fc09de1c1..2a79b24e9 100644 --- a/assets/js/4bfc8e71.2e3e19e2.js +++ b/assets/js/4bfc8e71.03baac51.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4015],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>m});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},d=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},u="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},g=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),u=p(n),g=a,m=u["".concat(s,".").concat(g)]||u[g]||c[g]||i;return n?r.createElement(m,o(o({ref:t},d),{},{components:n})):r.createElement(m,o({ref:t},d))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=g;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[u]="string"==typeof e?e:a,o[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>l,toc:()=>p});var r=n(7462),a=(n(7294),n(3905));const i={slug:"/getting-started/installing-wordpress-plugin",sidebar_position:4},o="Installing WordPress Plugin",l={unversionedId:"Getting Started/wordpress-plugin",id:"Getting Started/wordpress-plugin",title:"Installing WordPress Plugin",description:"Composer Installation (Recommended)",source:"@site/documentation/01-Getting Started/wordpress-plugin.md",sourceDirName:"01-Getting Started",slug:"/getting-started/installing-wordpress-plugin",permalink:"/docs/learn/getting-started/installing-wordpress-plugin",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/01-Getting Started/wordpress-plugin.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",sidebarPosition:4,frontMatter:{slug:"/getting-started/installing-wordpress-plugin",sidebar_position:4},sidebar:"tutorialSidebar",previous:{title:"Configuring the Framework",permalink:"/docs/learn/getting-started/headless-config"},next:{title:"Quick Introduction to the Framework",permalink:"/docs/learn/getting-started/quick-tutorial"}},s={},p=[{value:"Composer Installation (Recommended)",id:"composer-installation-recommended",level:2},{value:"Manual install",id:"manual-install",level:2},{value:"Enter the front-end site URL.",id:"enter-the-front-end-site-url",level:2}],d={toc:p};function u(e){let{components:t,...i}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,i,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"installing-wordpress-plugin"},"Installing WordPress Plugin"),(0,a.kt)("h2",{id:"composer-installation-recommended"},"Composer Installation (Recommended)"),(0,a.kt)("p",null,"The recommended method for installing this plugin is via composer: ",(0,a.kt)("inlineCode",{parentName:"p"},"composer require headstartwp/headstartwp"),"."),(0,a.kt)("p",null,"Make sure to set up the path for installing this as a WordPress Plugin:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-json"},'{\n "name": "your-vendor-name/your-project-name",\n "require": {\n "composer/installers": "^1.0",\n "headstartwp/headstartwp": "^1.0.0"\n },\n "extra": {\n "installer-paths": {\n "plugins/{$name}/": ["type:wordpress-plugin"]\n }\n },\n "config": {\n "allow-plugins": {\n "composer/installers": true\n }\n }\n}\n')),(0,a.kt)("h2",{id:"manual-install"},"Manual install"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp-plugin/archive/refs/heads/trunk.zip"},"Download the plugin's zip file"),", manually move it to ",(0,a.kt)("inlineCode",{parentName:"p"},"wp-content/plugins")," and activate the plugin."),(0,a.kt)("h2",{id:"enter-the-front-end-site-url"},"Enter the front-end site URL."),(0,a.kt)("p",null,"Go to ",(0,a.kt)("inlineCode",{parentName:"p"},"Settings -> General"),' and scroll down until you find the "Headless Frontend URL" and enter the URL for the Headless site.'),(0,a.kt)("p",null,(0,a.kt)("img",{alt:"Plugin settings",src:n(7607).Z,width:"835",height:"270"})))}u.isMDXComponent=!0},7607:(e,t,n)=>{n.d(t,{Z:()=>r});const r=n.p+"assets/images/plugin-settings-cd21201c2690c652abab12a4be1b0e31.png"}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4015],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>m});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},d=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},u="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},g=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),u=p(n),g=a,m=u["".concat(s,".").concat(g)]||u[g]||c[g]||i;return n?r.createElement(m,o(o({ref:t},d),{},{components:n})):r.createElement(m,o({ref:t},d))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=g;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[u]="string"==typeof e?e:a,o[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>l,toc:()=>p});var r=n(7462),a=(n(7294),n(3905));const i={slug:"/getting-started/installing-wordpress-plugin",sidebar_position:4},o="Installing WordPress Plugin",l={unversionedId:"Getting Started/wordpress-plugin",id:"Getting Started/wordpress-plugin",title:"Installing WordPress Plugin",description:"Composer Installation (Recommended)",source:"@site/documentation/01-Getting Started/wordpress-plugin.md",sourceDirName:"01-Getting Started",slug:"/getting-started/installing-wordpress-plugin",permalink:"/docs/learn/getting-started/installing-wordpress-plugin",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/01-Getting Started/wordpress-plugin.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",sidebarPosition:4,frontMatter:{slug:"/getting-started/installing-wordpress-plugin",sidebar_position:4},sidebar:"tutorialSidebar",previous:{title:"Configuring the Framework",permalink:"/docs/learn/getting-started/headless-config"},next:{title:"Quick Introduction to the Framework",permalink:"/docs/learn/getting-started/quick-tutorial"}},s={},p=[{value:"Composer Installation (Recommended)",id:"composer-installation-recommended",level:2},{value:"Manual install",id:"manual-install",level:2},{value:"Enter the front-end site URL.",id:"enter-the-front-end-site-url",level:2}],d={toc:p};function u(e){let{components:t,...i}=e;return(0,a.kt)("wrapper",(0,r.Z)({},d,i,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"installing-wordpress-plugin"},"Installing WordPress Plugin"),(0,a.kt)("h2",{id:"composer-installation-recommended"},"Composer Installation (Recommended)"),(0,a.kt)("p",null,"The recommended method for installing this plugin is via composer: ",(0,a.kt)("inlineCode",{parentName:"p"},"composer require headstartwp/headstartwp"),"."),(0,a.kt)("p",null,"Make sure to set up the path for installing this as a WordPress Plugin:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-json"},'{\n "name": "your-vendor-name/your-project-name",\n "require": {\n "composer/installers": "^1.0",\n "headstartwp/headstartwp": "^1.0.0"\n },\n "extra": {\n "installer-paths": {\n "plugins/{$name}/": ["type:wordpress-plugin"]\n }\n },\n "config": {\n "allow-plugins": {\n "composer/installers": true\n }\n }\n}\n')),(0,a.kt)("h2",{id:"manual-install"},"Manual install"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp-plugin/archive/refs/heads/trunk.zip"},"Download the plugin's zip file"),", manually move it to ",(0,a.kt)("inlineCode",{parentName:"p"},"wp-content/plugins")," and activate the plugin."),(0,a.kt)("h2",{id:"enter-the-front-end-site-url"},"Enter the front-end site URL."),(0,a.kt)("p",null,"Go to ",(0,a.kt)("inlineCode",{parentName:"p"},"Settings -> General"),' and scroll down until you find the "Headless Frontend URL" and enter the URL for the Headless site.'),(0,a.kt)("p",null,(0,a.kt)("img",{alt:"Plugin settings",src:n(7607).Z,width:"835",height:"270"})))}u.isMDXComponent=!0},7607:(e,t,n)=>{n.d(t,{Z:()=>r});const r=n.p+"assets/images/plugin-settings-cd21201c2690c652abab12a4be1b0e31.png"}}]); \ No newline at end of file diff --git a/assets/js/4c2ded29.dc84ee0f.js b/assets/js/4c2ded29.6d13ea00.js similarity index 95% rename from assets/js/4c2ded29.dc84ee0f.js rename to assets/js/4c2ded29.6d13ea00.js index c8879099d..d99a41948 100644 --- a/assets/js/4c2ded29.dc84ee0f.js +++ b/assets/js/4c2ded29.6d13ea00.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3955],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var d=r.createContext({}),s=function(e){var t=r.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},o=function(e){var t=s(e.components);return r.createElement(d.Provider,{value:t},e.children)},m="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,d=e.parentName,o=p(e,["components","mdxType","originalType","parentName"]),m=s(a),c=n,h=m["".concat(d,".").concat(c)]||m[c]||k[c]||i;return a?r.createElement(h,l(l({ref:t},o),{},{components:a})):r.createElement(h,l({ref:t},o))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=c;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p[m]="string"==typeof e?e:n,l[1]=p;for(var s=2;s{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>m,frontMatter:()=>i,metadata:()=>p,toc:()=>s});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.AbstractFetchStrategy",title:"Class: AbstractFetchStrategy",sidebar_label:"@headstartwp/core.AbstractFetchStrategy",custom_edit_url:null},l=void 0,p={unversionedId:"classes/headstartwp_core.AbstractFetchStrategy",id:"classes/headstartwp_core.AbstractFetchStrategy",title:"Class: AbstractFetchStrategy",description:"@headstartwp/core.AbstractFetchStrategy",source:"@site/docs/classes/headstartwp_core.AbstractFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.AbstractFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.AbstractFetchStrategy",title:"Class: AbstractFetchStrategy",sidebar_label:"@headstartwp/core.AbstractFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.LOGTYPE",permalink:"/docs/api/enums/headstartwp_core.LOGTYPE"},next:{title:"@headstartwp/core.AppSettingsStrategy",permalink:"/docs/api/classes/headstartwp_core.AppSettingsStrategy"}},d={},s=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getPreviewAuthHeader",id:"getpreviewauthheader",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getPreviewHeaderName",id:"getpreviewheadername",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-21",level:4}],o={toc:s};function m(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".AbstractFetchStrategy"),(0,n.kt)("p",null,"Abstract class that lays out a strategy for fetching data"),(0,n.kt)("p",null,"All Fetch Strategies should implement this class and it allows to share logic for fetching data both\non the front-end and on the back-end."),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"E")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"E")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The type of entity that is fetched (e.g PostEntity, TermEntity etc)")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Params")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams"))),(0,n.kt)("td",{parentName:"tr",align:"left"},"The type of the params that are passed to the endpoint")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"R")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"E")),(0,n.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"AbstractFetchStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"SinglePostFetchStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveFetchStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.SearchNativeFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"SearchNativeFetchStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AppSettingsStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AppSettingsStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"TaxonomyTermsStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"VerifyTokenFetchStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new AbstractFetchStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"E"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"E")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"E"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Params")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"R")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"E"))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L143"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:143")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L119"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:119")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L124"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:124")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Builds the final endpoint URL based on the passed parameters"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to add to the request")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The endpoint URL."),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L220"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:220")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("p",null,"The default fetcher function"),(0,n.kt)("p",null,"The default fetcher function handles authentication headers and errors from the API."),(0,n.kt)("p",null,"A custom strategy can override this function to run additional logic before or after the fetch call"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL to fetch")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetcher options")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L290"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:290")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"filterOptions?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"filterOptions?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L377"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:377")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L442"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:442")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L256"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:256")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L407"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:407")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("inlineCode",{parentName:"p"},"Abstract")," ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L135"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:135")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),">"),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L182"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:182")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L174"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:174")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("inlineCode",{parentName:"p"},"Abstract")," ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),">"),(0,n.kt)("p",null,"Returns the supported params from the URL if present."),(0,n.kt)("p",null,"These params are passed to ",(0,n.kt)("inlineCode",{parentName:"p"},"buildEndpointURL"),". If the strategy does not support\nmapping url params to endpoint params, it should return an empty object."),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The Path name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),">"),(0,n.kt)("p",null,"params extracted from the URL"),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L197"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:197")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewauthheader"},"getPreviewAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L247"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:247")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewheadername"},"getPreviewHeaderName"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewHeaderName"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L241"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:241")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"E"),">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L365"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:365")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L205"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:205")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),">"),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L417"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:417")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"E"),">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L233"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:233")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-14"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-16"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L164"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:164")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-15"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-17"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")))}m.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3955],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>c});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var d=r.createContext({}),s=function(e){var t=r.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},o=function(e){var t=s(e.components);return r.createElement(d.Provider,{value:t},e.children)},m="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,d=e.parentName,o=p(e,["components","mdxType","originalType","parentName"]),m=s(a),h=n,c=m["".concat(d,".").concat(h)]||m[h]||k[h]||i;return a?r.createElement(c,l(l({ref:t},o),{},{components:a})):r.createElement(c,l({ref:t},o))}));function c(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=h;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p[m]="string"==typeof e?e:n,l[1]=p;for(var s=2;s{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>m,frontMatter:()=>i,metadata:()=>p,toc:()=>s});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.AbstractFetchStrategy",title:"Class: AbstractFetchStrategy",sidebar_label:"@headstartwp/core.AbstractFetchStrategy",custom_edit_url:null},l=void 0,p={unversionedId:"classes/headstartwp_core.AbstractFetchStrategy",id:"classes/headstartwp_core.AbstractFetchStrategy",title:"Class: AbstractFetchStrategy",description:"@headstartwp/core.AbstractFetchStrategy",source:"@site/docs/classes/headstartwp_core.AbstractFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.AbstractFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.AbstractFetchStrategy",title:"Class: AbstractFetchStrategy",sidebar_label:"@headstartwp/core.AbstractFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.LOGTYPE",permalink:"/docs/api/enums/headstartwp_core.LOGTYPE"},next:{title:"@headstartwp/core.AppSettingsStrategy",permalink:"/docs/api/classes/headstartwp_core.AppSettingsStrategy"}},d={},s=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getPreviewAuthHeader",id:"getpreviewauthheader",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getPreviewHeaderName",id:"getpreviewheadername",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Defined in",id:"defined-in-21",level:4}],o={toc:s};function m(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".AbstractFetchStrategy"),(0,n.kt)("p",null,"Abstract class that lays out a strategy for fetching data"),(0,n.kt)("p",null,"All Fetch Strategies should implement this class and it allows to share logic for fetching data both\non the front-end and on the back-end."),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"E")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"E")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The type of entity that is fetched (e.g PostEntity, TermEntity etc)")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Params")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams"))),(0,n.kt)("td",{parentName:"tr",align:"left"},"The type of the params that are passed to the endpoint")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"R")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"E")),(0,n.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"AbstractFetchStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"SinglePostFetchStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveFetchStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.SearchNativeFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"SearchNativeFetchStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AppSettingsStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AppSettingsStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"TaxonomyTermsStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"VerifyTokenFetchStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new AbstractFetchStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"E"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"E")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"E"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Params")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"R")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"E"))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L143"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:143")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L119"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:119")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L124"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:124")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Builds the final endpoint URL based on the passed parameters"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to add to the request")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The endpoint URL."),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L220"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:220")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("p",null,"The default fetcher function"),(0,n.kt)("p",null,"The default fetcher function handles authentication headers and errors from the API."),(0,n.kt)("p",null,"A custom strategy can override this function to run additional logic before or after the fetch call"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL to fetch")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetcher options")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L290"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:290")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"filterOptions?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"filterOptions?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L377"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:377")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L442"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:442")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L256"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:256")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L407"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:407")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("inlineCode",{parentName:"p"},"Abstract")," ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L135"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:135")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),">"),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L182"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:182")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L174"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:174")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("inlineCode",{parentName:"p"},"Abstract")," ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),">"),(0,n.kt)("p",null,"Returns the supported params from the URL if present."),(0,n.kt)("p",null,"These params are passed to ",(0,n.kt)("inlineCode",{parentName:"p"},"buildEndpointURL"),". If the strategy does not support\nmapping url params to endpoint params, it should return an empty object."),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The Path name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),">"),(0,n.kt)("p",null,"params extracted from the URL"),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L197"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:197")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewauthheader"},"getPreviewAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L247"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:247")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewheadername"},"getPreviewHeaderName"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewHeaderName"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L241"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:241")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"E"),">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L365"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:365")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L205"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:205")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"Params"),">"),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L417"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:417")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"E"),">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"Params"),">")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L233"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:233")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-14"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-16"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L164"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:164")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-15"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-17"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4e3c32b5.91230ddd.js b/assets/js/4e3c32b5.4048c3fb.js similarity index 98% rename from assets/js/4e3c32b5.91230ddd.js rename to assets/js/4e3c32b5.4048c3fb.js index 2001097b5..52345f9b3 100644 --- a/assets/js/4e3c32b5.91230ddd.js +++ b/assets/js/4e3c32b5.4048c3fb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9530],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>m});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),l=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},c=function(e){var t=l(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,p=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=l(n),h=r,m=d["".concat(p,".").concat(h)]||d[h]||u[h]||o;return n?a.createElement(m,i(i({ref:t},c),{},{components:n})):a.createElement(m,i({ref:t},c))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,i=new Array(o);i[0]=h;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s[d]="string"==typeof e?e:r,i[1]=s;for(var l=2;l{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>l});var a=n(7462),r=(n(7294),n(3905));const o={slug:"/data-fetching/usepost",sidebar_position:1},i="The usePost hook",s={unversionedId:"Data Fetching/usePost",id:"Data Fetching/usePost",title:"The usePost hook",description:"The usePost hook is the Next.js binding for the useFetchPost.",source:"@site/documentation/02 - Data Fetching/usePost.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/usepost",permalink:"/docs/learn/data-fetching/usepost",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/usePost.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",sidebarPosition:1,frontMatter:{slug:"/data-fetching/usepost",sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"Introduction",permalink:"/docs/learn/data-fetching"},next:{title:"The usePosts hook",permalink:"/docs/learn/data-fetching/useposts"}},p={},l=[{value:"Basic Usage",id:"basic-usage",level:2},{value:"Post path matching",id:"post-path-matching",level:4},{value:"Fetching from multiple post types",id:"fetching-from-multiple-post-types",level:3},{value:"Fetching from a custom post type",id:"fetching-from-a-custom-post-type",level:2}],c={toc:l};function d(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"the-usepost-hook"},"The usePost hook"),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},"The ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next#usepost"},"usePost")," hook is the Next.js binding for the ",(0,r.kt)("a",{parentName:"p",href:"/api/namespaces/headstartwp_core.react#usefetchpost"},"useFetchPost"),".")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," hook fetches a single WordPress post from a registered post type. Its basic usage is very simple."),(0,r.kt)("h2",{id:"basic-usage"},"Basic Usage"),(0,r.kt)("p",null,"The basic usage is pretty simple and it assumes a route named ",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/[...path].js")," where the ",(0,r.kt)("inlineCode",{parentName:"p"},"slug")," is extracted from the URL."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/pages/[...path].js",title:"src/pages/[...path].js"},"import { usePost } from '@headstartwp/next';\n\nconst PostPage = () => {\n const { loading, error, data } = usePost();\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n

{data?.post.title.rendered}

\n
\n );\n};\n")),(0,r.kt)("h4",{id:"post-path-matching"},"Post path matching"),(0,r.kt)("admonition",{type:"caution"},(0,r.kt)("p",{parentName:"admonition"},"The behavior described here was implemented in version ",(0,r.kt)("strong",{parentName:"p"},"0.5.x")," of the framework and can be disabled by passing ",(0,r.kt)("inlineCode",{parentName:"p"},"matchCurrentPath: false")," to ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," (and ",(0,r.kt)("inlineCode",{parentName:"p"},"fetchHookData")," for server-side data fetching).")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," hook will by default match the current path captured by ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js")," with the post's link property. This ensures the right post is loaded and that 404 are issued to unsupported permalinks. "),(0,r.kt)("admonition",{type:"caution"},(0,r.kt)("p",{parentName:"admonition"},"The framework requires that the permalink structure set on the backend matches the URL structure being used on the front-end. "),(0,r.kt)("p",{parentName:"admonition"},"This means that if you include the date in your permalinks the URLs to a post without the date will 404 in the framework."),(0,r.kt)("p",{parentName:"admonition"},"This is also true for custom post types, if the WordPress backend expects a custom post type to be at ",(0,r.kt)("inlineCode",{parentName:"p"},"/book/book-name")," the front-end must also follow the same URL structure. If you wish to change the permalink structure for custom post types make sure to make the changes both in WordPress and in your front-end code.")),(0,r.kt)("p",null,"Example where path matches:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"User visits URL ",(0,r.kt)("inlineCode",{parentName:"li"},"/post-name")),(0,r.kt)("li",{parentName:"ul"},"The post with the ",(0,r.kt)("inlineCode",{parentName:"li"},"post-name")," slug contains a ",(0,r.kt)("inlineCode",{parentName:"li"},"http://backend.com/post-name")," link."),(0,r.kt)("li",{parentName:"ul"},"Since the URL and the path of ",(0,r.kt)("inlineCode",{parentName:"li"},"post.link")," matches the page/post is rendered.")),(0,r.kt)("p",null,"Example where path does not match:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"User visits URL ",(0,r.kt)("inlineCode",{parentName:"li"},"/parent-page/post-name")),(0,r.kt)("li",{parentName:"ul"},"The post with the ",(0,r.kt)("inlineCode",{parentName:"li"},"post-name")," slug contains a ",(0,r.kt)("inlineCode",{parentName:"li"},"http://backend.com/different-parent/post-name")," url"),(0,r.kt)("li",{parentName:"ul"},"Since the URL (",(0,r.kt)("inlineCode",{parentName:"li"},"/parent-page/post-name"),") and the path of ",(0,r.kt)("inlineCode",{parentName:"li"},"post.link")," (",(0,r.kt)("inlineCode",{parentName:"li"},"different-parent/post-name"),") ",(0,r.kt)("strong",{parentName:"li"},"do not")," match a 404 page is issued.")),(0,r.kt)("p",null,"Example where path does not match but is redirected to the right one:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"User visits URL ",(0,r.kt)("inlineCode",{parentName:"li"},"/post-name")),(0,r.kt)("li",{parentName:"ul"},"The post with the ",(0,r.kt)("inlineCode",{parentName:"li"},"post-name")," slug contains a ",(0,r.kt)("inlineCode",{parentName:"li"},"http://backend.com/2022/10/30/post-name")," url"),(0,r.kt)("li",{parentName:"ul"},"Since the URL and the path of ",(0,r.kt)("inlineCode",{parentName:"li"},"post.link")," do not match, a NotFound error is thrown"),(0,r.kt)("li",{parentName:"ul"},"If prefetching is setup following ",(0,r.kt)("a",{parentName:"li",href:"/learn/data-fetching/prefetching"},"pre-fetching")," and ",(0,r.kt)("inlineCode",{parentName:"li"},"redirectStrategy"),' is set to "404" or "always" in ',(0,r.kt)("inlineCode",{parentName:"li"},"headstartwp.config.js"),", ",(0,r.kt)("inlineCode",{parentName:"li"},"handleError")," will then look if there's a redirect available and since WordPress redirects ",(0,r.kt)("inlineCode",{parentName:"li"},"/post-name")," to ",(0,r.kt)("inlineCode",{parentName:"li"},"/2022/10/30/post-name"),", the framework will also perform the redirect.")),(0,r.kt)("h3",{id:"fetching-from-multiple-post-types"},"Fetching from multiple post types"),(0,r.kt)("p",null,"When specifying an array of post type, the slug will be searched in both endpoint and the first one to return a valid post object will be used."),(0,r.kt)("admonition",{type:"caution"},(0,r.kt)("p",{parentName:"admonition"},"This might result in URL conflicts, i.e a post or page using the same slug. The first post type specified will take precedence. In such cases, consider using a different URL structure for each for instance (e.g: using ",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/article/[...path].js")," for posts).")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/[...path].js"',title:'"src/pages/[...path].js"'},"import { usePost } from '@headstartwp/next';\n\nconst PostOrPage = () => {\n const { loading, error, data } = usePost({ postType: ['page', 'post'] });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n

{data?.post.title.rendered}

\n
\n );\n};\n")),(0,r.kt)("h2",{id:"fetching-from-a-custom-post-type"},"Fetching from a custom post type"),(0,r.kt)("p",null,"To fetch a single from a custom post type, first declare the custom post type in ",(0,r.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," as explained in the ",(0,r.kt)("a",{parentName:"p",href:"/learn/getting-started/headless-config#custom-post-types"},"headstartwp.config.js")," section."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/book/[...path].js"',title:'"src/pages/book/[...path].js"'},"import { usePost } from '@headstartwp/next';\n\nconst PostPage = () => {\n const { loading, error, data } = usePost({ postType: 'book' });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n

{data?.post.title.rendered}

\n
\n );\n};\n")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9530],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>m});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),l=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},c=function(e){var t=l(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,p=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=l(n),h=r,m=d["".concat(p,".").concat(h)]||d[h]||u[h]||o;return n?a.createElement(m,i(i({ref:t},c),{},{components:n})):a.createElement(m,i({ref:t},c))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,i=new Array(o);i[0]=h;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s[d]="string"==typeof e?e:r,i[1]=s;for(var l=2;l{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>l});var a=n(7462),r=(n(7294),n(3905));const o={slug:"/data-fetching/usepost",sidebar_position:1},i="The usePost hook",s={unversionedId:"Data Fetching/usePost",id:"Data Fetching/usePost",title:"The usePost hook",description:"The usePost hook is the Next.js binding for the useFetchPost.",source:"@site/documentation/02 - Data Fetching/usePost.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/usepost",permalink:"/docs/learn/data-fetching/usepost",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/usePost.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",sidebarPosition:1,frontMatter:{slug:"/data-fetching/usepost",sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"Introduction",permalink:"/docs/learn/data-fetching"},next:{title:"The usePosts hook",permalink:"/docs/learn/data-fetching/useposts"}},p={},l=[{value:"Basic Usage",id:"basic-usage",level:2},{value:"Post path matching",id:"post-path-matching",level:4},{value:"Fetching from multiple post types",id:"fetching-from-multiple-post-types",level:3},{value:"Fetching from a custom post type",id:"fetching-from-a-custom-post-type",level:2}],c={toc:l};function d(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"the-usepost-hook"},"The usePost hook"),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},"The ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next#usepost"},"usePost")," hook is the Next.js binding for the ",(0,r.kt)("a",{parentName:"p",href:"/api/namespaces/headstartwp_core.react#usefetchpost"},"useFetchPost"),".")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," hook fetches a single WordPress post from a registered post type. Its basic usage is very simple."),(0,r.kt)("h2",{id:"basic-usage"},"Basic Usage"),(0,r.kt)("p",null,"The basic usage is pretty simple and it assumes a route named ",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/[...path].js")," where the ",(0,r.kt)("inlineCode",{parentName:"p"},"slug")," is extracted from the URL."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/pages/[...path].js",title:"src/pages/[...path].js"},"import { usePost } from '@headstartwp/next';\n\nconst PostPage = () => {\n const { loading, error, data } = usePost();\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n

{data?.post.title.rendered}

\n
\n );\n};\n")),(0,r.kt)("h4",{id:"post-path-matching"},"Post path matching"),(0,r.kt)("admonition",{type:"caution"},(0,r.kt)("p",{parentName:"admonition"},"The behavior described here was implemented in version ",(0,r.kt)("strong",{parentName:"p"},"0.5.x")," of the framework and can be disabled by passing ",(0,r.kt)("inlineCode",{parentName:"p"},"matchCurrentPath: false")," to ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," (and ",(0,r.kt)("inlineCode",{parentName:"p"},"fetchHookData")," for server-side data fetching).")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," hook will by default match the current path captured by ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js")," with the post's link property. This ensures the right post is loaded and that 404 are issued to unsupported permalinks. "),(0,r.kt)("admonition",{type:"caution"},(0,r.kt)("p",{parentName:"admonition"},"The framework requires that the permalink structure set on the backend matches the URL structure being used on the front-end. "),(0,r.kt)("p",{parentName:"admonition"},"This means that if you include the date in your permalinks the URLs to a post without the date will 404 in the framework."),(0,r.kt)("p",{parentName:"admonition"},"This is also true for custom post types, if the WordPress backend expects a custom post type to be at ",(0,r.kt)("inlineCode",{parentName:"p"},"/book/book-name")," the front-end must also follow the same URL structure. If you wish to change the permalink structure for custom post types make sure to make the changes both in WordPress and in your front-end code.")),(0,r.kt)("p",null,"Example where path matches:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"User visits URL ",(0,r.kt)("inlineCode",{parentName:"li"},"/post-name")),(0,r.kt)("li",{parentName:"ul"},"The post with the ",(0,r.kt)("inlineCode",{parentName:"li"},"post-name")," slug contains a ",(0,r.kt)("inlineCode",{parentName:"li"},"http://backend.com/post-name")," link."),(0,r.kt)("li",{parentName:"ul"},"Since the URL and the path of ",(0,r.kt)("inlineCode",{parentName:"li"},"post.link")," matches the page/post is rendered.")),(0,r.kt)("p",null,"Example where path does not match:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"User visits URL ",(0,r.kt)("inlineCode",{parentName:"li"},"/parent-page/post-name")),(0,r.kt)("li",{parentName:"ul"},"The post with the ",(0,r.kt)("inlineCode",{parentName:"li"},"post-name")," slug contains a ",(0,r.kt)("inlineCode",{parentName:"li"},"http://backend.com/different-parent/post-name")," url"),(0,r.kt)("li",{parentName:"ul"},"Since the URL (",(0,r.kt)("inlineCode",{parentName:"li"},"/parent-page/post-name"),") and the path of ",(0,r.kt)("inlineCode",{parentName:"li"},"post.link")," (",(0,r.kt)("inlineCode",{parentName:"li"},"different-parent/post-name"),") ",(0,r.kt)("strong",{parentName:"li"},"do not")," match a 404 page is issued.")),(0,r.kt)("p",null,"Example where path does not match but is redirected to the right one:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"User visits URL ",(0,r.kt)("inlineCode",{parentName:"li"},"/post-name")),(0,r.kt)("li",{parentName:"ul"},"The post with the ",(0,r.kt)("inlineCode",{parentName:"li"},"post-name")," slug contains a ",(0,r.kt)("inlineCode",{parentName:"li"},"http://backend.com/2022/10/30/post-name")," url"),(0,r.kt)("li",{parentName:"ul"},"Since the URL and the path of ",(0,r.kt)("inlineCode",{parentName:"li"},"post.link")," do not match, a NotFound error is thrown"),(0,r.kt)("li",{parentName:"ul"},"If prefetching is setup following ",(0,r.kt)("a",{parentName:"li",href:"/learn/data-fetching/prefetching"},"pre-fetching")," and ",(0,r.kt)("inlineCode",{parentName:"li"},"redirectStrategy"),' is set to "404" or "always" in ',(0,r.kt)("inlineCode",{parentName:"li"},"headstartwp.config.js"),", ",(0,r.kt)("inlineCode",{parentName:"li"},"handleError")," will then look if there's a redirect available and since WordPress redirects ",(0,r.kt)("inlineCode",{parentName:"li"},"/post-name")," to ",(0,r.kt)("inlineCode",{parentName:"li"},"/2022/10/30/post-name"),", the framework will also perform the redirect.")),(0,r.kt)("h3",{id:"fetching-from-multiple-post-types"},"Fetching from multiple post types"),(0,r.kt)("p",null,"When specifying an array of post type, the slug will be searched in both endpoint and the first one to return a valid post object will be used."),(0,r.kt)("admonition",{type:"caution"},(0,r.kt)("p",{parentName:"admonition"},"This might result in URL conflicts, i.e a post or page using the same slug. The first post type specified will take precedence. In such cases, consider using a different URL structure for each for instance (e.g: using ",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/article/[...path].js")," for posts).")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/[...path].js"',title:'"src/pages/[...path].js"'},"import { usePost } from '@headstartwp/next';\n\nconst PostOrPage = () => {\n const { loading, error, data } = usePost({ postType: ['page', 'post'] });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n

{data?.post.title.rendered}

\n
\n );\n};\n")),(0,r.kt)("h2",{id:"fetching-from-a-custom-post-type"},"Fetching from a custom post type"),(0,r.kt)("p",null,"To fetch a single from a custom post type, first declare the custom post type in ",(0,r.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," as explained in the ",(0,r.kt)("a",{parentName:"p",href:"/learn/getting-started/headless-config#custom-post-types"},"headstartwp.config.js")," section."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/book/[...path].js"',title:'"src/pages/book/[...path].js"'},"import { usePost } from '@headstartwp/next';\n\nconst PostPage = () => {\n const { loading, error, data } = usePost({ postType: 'book' });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n

{data?.post.title.rendered}

\n
\n );\n};\n")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4e62b870.1cb66746.js b/assets/js/4e62b870.a5fbb534.js similarity index 96% rename from assets/js/4e62b870.1cb66746.js rename to assets/js/4e62b870.a5fbb534.js index 5338d7834..3bf1bd8fb 100644 --- a/assets/js/4e62b870.1cb66746.js +++ b/assets/js/4e62b870.a5fbb534.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5700],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||l;return a?r.createElement(h,i(i({ref:t},d),{},{components:a})):r.createElement(h,i({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,i=new Array(l);i[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.IFileBlock",title:"Interface: IFileBlock",sidebar_label:"@headstartwp/core.react.IFileBlock",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.IFileBlock",id:"interfaces/headstartwp_core.react.IFileBlock",title:"Interface: IFileBlock",description:"@headstartwp/core.react.IFileBlock",source:"@site/docs/interfaces/headstartwp_core.react.IFileBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IFileBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IFileBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IFileBlock",title:"Interface: IFileBlock",sidebar_label:"@headstartwp/core.react.IFileBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IDataWPBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IDataWPBlock"},next:{title:"@headstartwp/core.react.IGroupBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IGroupBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IFileBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"FileBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IFileBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"FileBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"FileBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5700],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||l;return a?r.createElement(h,i(i({ref:t},d),{},{components:a})):r.createElement(h,i({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,i=new Array(l);i[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.IFileBlock",title:"Interface: IFileBlock",sidebar_label:"@headstartwp/core.react.IFileBlock",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.IFileBlock",id:"interfaces/headstartwp_core.react.IFileBlock",title:"Interface: IFileBlock",description:"@headstartwp/core.react.IFileBlock",source:"@site/docs/interfaces/headstartwp_core.react.IFileBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IFileBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IFileBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IFileBlock",title:"Interface: IFileBlock",sidebar_label:"@headstartwp/core.react.IFileBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IDataWPBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IDataWPBlock"},next:{title:"@headstartwp/core.react.IGroupBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IGroupBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IFileBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"FileBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IFileBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"FileBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"FileBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4e86766f.2525c84a.js b/assets/js/4e86766f.fa3ebd16.js similarity index 90% rename from assets/js/4e86766f.2525c84a.js rename to assets/js/4e86766f.fa3ebd16.js index 44d2908cc..bff0ef5f6 100644 --- a/assets/js/4e86766f.2525c84a.js +++ b/assets/js/4e86766f.fa3ebd16.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6741],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function o(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),d=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},c=function(e){var t=d(e.components);return n.createElement(p.Provider,{value:t},e.children)},s="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,p=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),s=d(a),k=r,h=s["".concat(p,".").concat(k)]||s[k]||m[k]||l;return a?n.createElement(h,o(o({ref:t},c),{},{components:a})):n.createElement(h,o({ref:t},c))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,o=new Array(l);o[0]=k;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:r,o[1]=i;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>l,metadata:()=>i,toc:()=>d});var n=a(7462),r=(a(7294),a(3905));const l={id:"headstartwp_core.react.BlockProps",title:"Interface: BlockProps",sidebar_label:"@headstartwp/core.react.BlockProps",custom_edit_url:null},o=void 0,i={unversionedId:"interfaces/headstartwp_core.react.BlockProps",id:"interfaces/headstartwp_core.react.BlockProps",title:"Interface: BlockProps",description:"@headstartwp/core.react.BlockProps",source:"@site/docs/interfaces/headstartwp_core.react.BlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.BlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.BlockProps",title:"Interface: BlockProps",sidebar_label:"@headstartwp/core.react.BlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.BlockAttributes",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockAttributes"},next:{title:"@headstartwp/core.react.BlockRendererProps",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockRendererProps"}},p={},d=[{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"domNode",id:"domnode",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-3",level:4},{value:"style",id:"style",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"tagName",id:"tagname",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"test",id:"test",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Defined in",id:"defined-in-6",level:4}],c={toc:d};function s(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".BlockProps"),(0,r.kt)("p",null,"The interface any children of ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#blocksrenderer"},"BlocksRenderer")," must implement."),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"children"},"children"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"children"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,r.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,r.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classlist"},"classList"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"classList"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domnode"},"domNode"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"domNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("p",null,"The actual domNode that was replaced with the react component"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L46"},"packages/core/src/react/components/BlocksRenderer.tsx:46")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,r.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"childNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"style"},"style"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"style"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The style tag of the domNode as an object."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tagname"},"tagName"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tagName"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"test"},"test"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"test"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"A test function receives a domNode and returns a boolean value indicating\nwhether that domNode should be replaced with the React component"),(0,r.kt)("h5",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"domNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h5",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L19"},"packages/core/src/react/components/BlocksRenderer.tsx:19")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6741],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function o(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),d=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},s=function(e){var t=d(e.components);return n.createElement(p.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,p=e.parentName,s=i(e,["components","mdxType","originalType","parentName"]),c=d(a),k=r,h=c["".concat(p,".").concat(k)]||c[k]||m[k]||l;return a?n.createElement(h,o(o({ref:t},s),{},{components:a})):n.createElement(h,o({ref:t},s))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,o=new Array(l);o[0]=k;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[c]="string"==typeof e?e:r,o[1]=i;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>c,frontMatter:()=>l,metadata:()=>i,toc:()=>d});var n=a(7462),r=(a(7294),a(3905));const l={id:"headstartwp_core.react.BlockProps",title:"Interface: BlockProps",sidebar_label:"@headstartwp/core.react.BlockProps",custom_edit_url:null},o=void 0,i={unversionedId:"interfaces/headstartwp_core.react.BlockProps",id:"interfaces/headstartwp_core.react.BlockProps",title:"Interface: BlockProps",description:"@headstartwp/core.react.BlockProps",source:"@site/docs/interfaces/headstartwp_core.react.BlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.BlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.BlockProps",title:"Interface: BlockProps",sidebar_label:"@headstartwp/core.react.BlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.BlockAttributes",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockAttributes"},next:{title:"@headstartwp/core.react.BlockRendererProps",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockRendererProps"}},p={},d=[{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"domNode",id:"domnode",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-3",level:4},{value:"style",id:"style",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"tagName",id:"tagname",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"test",id:"test",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Defined in",id:"defined-in-6",level:4}],s={toc:d};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".BlockProps"),(0,r.kt)("p",null,"The interface any children of ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#blocksrenderer"},"BlocksRenderer")," must implement."),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"children"},"children"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"children"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,r.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,r.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classlist"},"classList"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"classList"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domnode"},"domNode"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"domNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("p",null,"The actual domNode that was replaced with the react component"),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L46"},"packages/core/src/react/components/BlocksRenderer.tsx:46")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,r.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"childNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"style"},"style"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"style"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The style tag of the domNode as an object."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tagname"},"tagName"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tagName"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"test"},"test"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"test"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"domNode"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"A test function receives a domNode and returns a boolean value indicating\nwhether that domNode should be replaced with the React component"),(0,r.kt)("h5",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"domNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h5",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L19"},"packages/core/src/react/components/BlocksRenderer.tsx:19")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/4ef87eef.aee7991f.js b/assets/js/4ef87eef.0345b684.js similarity index 80% rename from assets/js/4ef87eef.aee7991f.js rename to assets/js/4ef87eef.0345b684.js index 0a25ae65e..965f25c2e 100644 --- a/assets/js/4ef87eef.aee7991f.js +++ b/assets/js/4ef87eef.0345b684.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3178],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>f});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),l=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},d=function(e){var t=l(e.components);return r.createElement(o.Provider,{value:t},e.children)},s="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=c(e,["components","mdxType","originalType","parentName"]),s=l(a),u=n,f=s["".concat(o,".").concat(u)]||s[u]||h[u]||i;return a?r.createElement(f,p(p({ref:t},d),{},{components:a})):r.createElement(f,p({ref:t},d))}));function f(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=u;var c={};for(var o in t)hasOwnProperty.call(t,o)&&(c[o]=t[o]);c.originalType=e,c[s]="string"==typeof e?e:n,p[1]=c;for(var l=2;l{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>p,default:()=>s,frontMatter:()=>i,metadata:()=>c,toc:()=>l});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.SearchObjectEntity",title:"Interface: SearchObjectEntity",sidebar_label:"@headstartwp/core.SearchObjectEntity",custom_edit_url:null},p=void 0,c={unversionedId:"interfaces/headstartwp_core.SearchObjectEntity",id:"interfaces/headstartwp_core.SearchObjectEntity",title:"Interface: SearchObjectEntity",description:"@headstartwp/core.SearchObjectEntity",source:"@site/docs/interfaces/headstartwp_core.SearchObjectEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.SearchObjectEntity",permalink:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.SearchObjectEntity",title:"Interface: SearchObjectEntity",sidebar_label:"@headstartwp/core.SearchObjectEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.SearchEntity",permalink:"/docs/api/interfaces/headstartwp_core.SearchEntity"},next:{title:"@headstartwp/core.SearchParams",permalink:"/docs/api/interfaces/headstartwp_core.SearchParams"}},o={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-5",level:4}],d={toc:l};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".SearchObjectEntity"),(0,n.kt)("p",null,"Interface for search object entities from the /wp/v2/search endpoint."),(0,n.kt)("p",null,"Interfaces that extends from this one are:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"},"PostSearchEntity"),"."),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.TermSearchEntity"},"TermSearchEntity"),".")),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,n.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"SearchObjectEntity"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostSearchEntity"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermSearchEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermSearchEntity"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"id"},"id"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"id"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"Unique identifier for the object."),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L658"},"packages/core/src/data/types/entities.ts:658")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"title"},"title"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"title"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The title for the object."),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L668"},"packages/core/src/data/types/entities.ts:668")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"type"},"type"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"type"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"post"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"term"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"post-format"')),(0,n.kt)("p",null,"Type of Search for the object."),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L673"},"packages/core/src/data/types/entities.ts:673")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"url"},"url"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"url"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"URL to the object."),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L663"},"packages/core/src/data/types/entities.ts:663")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3178],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>f});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var l=r.createContext({}),s=function(e){var t=r.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},c=function(e){var t=s(e.components);return r.createElement(l.Provider,{value:t},e.children)},d="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,l=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),d=s(a),u=n,f=d["".concat(l,".").concat(u)]||d[u]||h[u]||i;return a?r.createElement(f,p(p({ref:t},c),{},{components:a})):r.createElement(f,p({ref:t},c))}));function f(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=u;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o[d]="string"==typeof e?e:n,p[1]=o;for(var s=2;s{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>s});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.SearchObjectEntity",title:"Interface: SearchObjectEntity",sidebar_label:"@headstartwp/core.SearchObjectEntity",custom_edit_url:null},p=void 0,o={unversionedId:"interfaces/headstartwp_core.SearchObjectEntity",id:"interfaces/headstartwp_core.SearchObjectEntity",title:"Interface: SearchObjectEntity",description:"@headstartwp/core.SearchObjectEntity",source:"@site/docs/interfaces/headstartwp_core.SearchObjectEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.SearchObjectEntity",permalink:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.SearchObjectEntity",title:"Interface: SearchObjectEntity",sidebar_label:"@headstartwp/core.SearchObjectEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.SearchEntity",permalink:"/docs/api/interfaces/headstartwp_core.SearchEntity"},next:{title:"@headstartwp/core.SearchParams",permalink:"/docs/api/interfaces/headstartwp_core.SearchParams"}},l={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-5",level:4}],c={toc:s};function d(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".SearchObjectEntity"),(0,n.kt)("p",null,"Interface for search object entities from the /wp/v2/search endpoint."),(0,n.kt)("p",null,"Interfaces that extends from this one are:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"},"PostSearchEntity"),"."),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.TermSearchEntity"},"TermSearchEntity"),".")),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,n.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"SearchObjectEntity"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostSearchEntity"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermSearchEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermSearchEntity"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"id"},"id"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"id"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"Unique identifier for the object."),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L658"},"packages/core/src/data/types/entities.ts:658")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"title"},"title"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"title"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The title for the object."),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L668"},"packages/core/src/data/types/entities.ts:668")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"type"},"type"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"type"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"post"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"term"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"post-format"')),(0,n.kt)("p",null,"Type of Search for the object."),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L673"},"packages/core/src/data/types/entities.ts:673")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"url"},"url"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"url"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"URL to the object."),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L663"},"packages/core/src/data/types/entities.ts:663")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/54355d51.d5ff2d57.js b/assets/js/54355d51.86a4b08d.js similarity index 96% rename from assets/js/54355d51.d5ff2d57.js rename to assets/js/54355d51.86a4b08d.js index fcf24443a..fbe2ab4f9 100644 --- a/assets/js/54355d51.d5ff2d57.js +++ b/assets/js/54355d51.86a4b08d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4409],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||l;return a?r.createElement(h,i(i({ref:t},d),{},{components:a})):r.createElement(h,i({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,i=new Array(l);i[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.IParagraphBlock",title:"Interface: IParagraphBlock",sidebar_label:"@headstartwp/core.react.IParagraphBlock",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.IParagraphBlock",id:"interfaces/headstartwp_core.react.IParagraphBlock",title:"Interface: IParagraphBlock",description:"@headstartwp/core.react.IParagraphBlock",source:"@site/docs/interfaces/headstartwp_core.react.IParagraphBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IParagraphBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IParagraphBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IParagraphBlock",title:"Interface: IParagraphBlock",sidebar_label:"@headstartwp/core.react.IParagraphBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IMediaTextBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IMediaTextBlock"},next:{title:"@headstartwp/core.react.IPreformattedBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IPreformattedBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IParagraphBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ParagraphBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IParagraphBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ParagraphBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ParagraphBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4409],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||l;return a?r.createElement(h,i(i({ref:t},d),{},{components:a})):r.createElement(h,i({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,i=new Array(l);i[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.IParagraphBlock",title:"Interface: IParagraphBlock",sidebar_label:"@headstartwp/core.react.IParagraphBlock",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.IParagraphBlock",id:"interfaces/headstartwp_core.react.IParagraphBlock",title:"Interface: IParagraphBlock",description:"@headstartwp/core.react.IParagraphBlock",source:"@site/docs/interfaces/headstartwp_core.react.IParagraphBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IParagraphBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IParagraphBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IParagraphBlock",title:"Interface: IParagraphBlock",sidebar_label:"@headstartwp/core.react.IParagraphBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IMediaTextBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IMediaTextBlock"},next:{title:"@headstartwp/core.react.IPreformattedBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IPreformattedBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IParagraphBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ParagraphBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IParagraphBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ParagraphBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ParagraphBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/54d19cbf.29680490.js b/assets/js/54d19cbf.2cc48cc8.js similarity index 99% rename from assets/js/54d19cbf.29680490.js rename to assets/js/54d19cbf.2cc48cc8.js index 17d1e4238..34961fdbc 100644 --- a/assets/js/54d19cbf.29680490.js +++ b/assets/js/54d19cbf.2cc48cc8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[825],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>g});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var l=a.createContext({}),d=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=d(e.components);return a.createElement(l.Provider,{value:t},e.children)},u="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=d(n),h=i,g=u["".concat(l,".").concat(h)]||u[h]||c[h]||r;return n?a.createElement(g,o(o({ref:t},p),{},{components:n})):a.createElement(g,o({ref:t},p))}));function g(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,o=new Array(r);o[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[u]="string"==typeof e?e:i,o[1]=s;for(var d=2;d{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>d});var a=n(7462),i=(n(7294),n(3905));const r={sidebar_position:2,slug:"/wordpress-integration/revalidate"},o="On-demand ISR revalidation",s={unversionedId:"WordPress Integration/revalidate",id:"WordPress Integration/revalidate",title:"On-demand ISR revalidation",description:"On-demand Revalidation is the ability to revalidate static pages programmatically from the CMS.",source:"@site/documentation/06-WordPress Integration/revalidate.md",sourceDirName:"06-WordPress Integration",slug:"/wordpress-integration/revalidate",permalink:"/docs/learn/wordpress-integration/revalidate",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/06-WordPress Integration/revalidate.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",sidebarPosition:2,frontMatter:{sidebar_position:2,slug:"/wordpress-integration/revalidate"},sidebar:"tutorialSidebar",previous:{title:"Multisite",permalink:"/docs/learn/wordpress-integration/multisite"},next:{title:"Basic Auth",permalink:"/docs/learn/wordpress-integration/basic-auth"}},l={},d=[{value:"Usage",id:"usage",level:2},{value:"Plugin setup",id:"plugin-setup",level:3},{value:"Revalidate Endpoint",id:"revalidate-endpoint",level:3},{value:"How does it work?",id:"how-does-it-work",level:2},{value:"Supporting Next.js ISR outside of Vercel",id:"supporting-nextjs-isr-outside-of-vercel",level:2},{value:"@10up/next-redis-cache-provider",id:"10upnext-redis-cache-provider",level:3},{value:"Purging the CDN Cache",id:"purging-the-cdn-cache",level:3},{value:"A note about WordPress VIP",id:"a-note-about-wordpress-vip",level:4},{value:"Revalidating in a Cron Job",id:"revalidating-in-a-cron-job",level:3}],p={toc:d};function u(e){let{components:t,...r}=e;return(0,i.kt)("wrapper",(0,a.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"on-demand-isr-revalidation"},"On-demand ISR revalidation"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/basic-features/data-fetching/incremental-static-regeneration#on-demand-revalidation"},"On-demand Revalidation")," is the ability to revalidate static pages programmatically from the CMS."),(0,i.kt)("p",null,"Without On-demand ISR revalidation users will need to wait until the time set in the ",(0,i.kt)("inlineCode",{parentName:"p"},"revalidate")," prop has passed before they can see an updated version of that page. This means that if a ",(0,i.kt)("inlineCode",{parentName:"p"},"revalidate")," is set to 5min, users would potentially have to wait up to 5min before they can see new content."),(0,i.kt)("p",null,'It is preferred to have the CMS ask the Next.js app to revalidate those pages when possible. This can be done via "On-Demand Revalidation".'),(0,i.kt)("p",null,"HeadstartWP supports Next.js ISR via the WordPress plugin and via ",(0,i.kt)("inlineCode",{parentName:"p"},"@10up/next-redis-cache-provider")," for hosts that do not natively support Next.js ISR (e.g. VIP, WPEngine etc)."),(0,i.kt)("h2",{id:"usage"},"Usage"),(0,i.kt)("h3",{id:"plugin-setup"},"Plugin setup"),(0,i.kt)("p",null,"HeadstartWP supports On-Demand Revalidation and it requires installing the WordPress Plugin. On-Demand Revalidation is opt-in and must be manually enabled in the plugin's settings (Settings -> General).\n",(0,i.kt)("img",{alt:"Plugin settings",src:n(7607).Z,width:"835",height:"270"})),(0,i.kt)("p",null,"The plugin expects the revalidate endpoint to live at ",(0,i.kt)("inlineCode",{parentName:"p"},"/api/revalidate"),". It is possible to customize this endpoint via the ",(0,i.kt)("inlineCode",{parentName:"p"},"tenup_headless_isr_revalidate_endpoint"),"."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-php"},"/**\n * Filters the revalidate endpoint.\n *\n * @param string $revalidate_endpoint The revalidate endpoint\n */\n$revalidate_endpoint = apply_filters( \n 'tenup_headless_isr_revalidate_endpoint', \n trailingslashit( Plugin::get_react_url() ) . 'api/revalidate' \n);\n")),(0,i.kt)("h3",{id:"revalidate-endpoint"},"Revalidate Endpoint"),(0,i.kt)("p",null,"Simply create a Next.js API endpoint that uses the ",(0,i.kt)("inlineCode",{parentName:"p"},"revalidateHandler")," provided by the framework. "),(0,i.kt)("admonition",{type:"caution"},(0,i.kt)("p",{parentName:"admonition"},"If you changed the default value of the endpoint path via the ",(0,i.kt)("inlineCode",{parentName:"p"},"tenup_headless_isr_revalidate_endpoint")," filter, make sure you change it in the Next.js app as well. ")),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-javascript",metastring:'title="src/pages/api/revalidate"',title:'"src/pages/api/revalidate"'},"import { revalidateHandler } from '@headstartwp/next';\n\n/**\n * The revalidate endpoint just needs to proxy the default revalidate handler\n *\n * @param {*} req Next.js request object\n * @param {*} res Next.js response object\n *\n * @returns\n */\nexport default async function handler(req, res) {\n return revalidateHandler(req, res);\n}\n")),(0,i.kt)("h2",{id:"how-does-it-work"},"How does it work?"),(0,i.kt)("p",null,"The default implementation will revalidate any post or page upon saving in WordPress. You can see the logic ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/develop/wp/headless-wp/includes/classes/CacheFlush/CacheFlush.php#L40"},"here"),"."),(0,i.kt)("h2",{id:"supporting-nextjs-isr-outside-of-vercel"},"Supporting Next.js ISR outside of Vercel"),(0,i.kt)("p",null,"If your host does not support Next.js ISR natively (e.g. WordPress VIP, WPEngine etc), ISR won't work well. If your hosting is serving your app via a traditional non-serverless setup using docker/kubernetes you most likely will run into issues trying to leverage Next.js ISR."),(0,i.kt)("p",null,"First off, if multiple containers are running to serve the requests to your website, a call to revalidate a particular page will only ever hit one of the containers that are running. This will lead to users being served by the containers that weren't hit by the WP call to still serve the old page. Even worse, the same user might be served by different containers and get both old and new responses for a page (e.g. the initial HTML is updated but the JSON associated with the page isn't)."),(0,i.kt)("p",null,"Officially, Next.js ",(0,i.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/pages/building-your-application/data-fetching/incremental-static-regeneration#self-hosting-isr"},"recommends")," sharing a writable volume across all the containers but that has some performance implications and some hosts simply don't support this setup."),(0,i.kt)("h3",{id:"10upnext-redis-cache-provider"},"@10up/next-redis-cache-provider"),(0,i.kt)("admonition",{type:"caution"},(0,i.kt)("p",{parentName:"admonition"},"If you are hosting on Vercel you do not need this package.")),(0,i.kt)("p",null,"Our solution to this problem has been to replace the filesystem cache with a redis cache provider. So whenever Next.js revalidates a page instead of storing the static page in disk, it will write to a shared redis instance that all of the containers would be talking to. The diagram below exemplifies how it works."),(0,i.kt)("p",null,(0,i.kt)("img",{alt:"Plugin settings",src:n(5218).Z,width:"2318",height:"819"})),(0,i.kt)("p",null,"To set up ",(0,i.kt)("inlineCode",{parentName:"p"},"@10up/next-redis-cache-provider")," first install it via npm:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-bash"},"npm install --save @10up/next-redis-cache-provider\n")),(0,i.kt)("p",null,"Then add it in ",(0,i.kt)("inlineCode",{parentName:"p"},"next.config.js"),":"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="next.config.js"',title:'"next.config.js"'},"const { withHeadstartWPConfig } = require('@headstartwp/next/config');\n\n/**\n * Update whatever you need within the nextConfig object.\n *\n * @type {import('next').NextConfig}\n */\nconst nextConfig = {\n eslint: {\n ignoreDuringBuilds: true,\n },\n};\n\n\nif (process.env.NEXT_REDIS_URL || process.env.VIP_REDIS_PRIMARY) {\n // eslint-disable-next-line global-require\n const { initRedisClient } = require('@10up/next-redis-cache-provider');\n initRedisClient();\n nextConfig.experimental = {\n incrementalCacheHandlerPath: require.resolve('@10up/next-redis-cache-provider'),\n };\n}\n\nmodule.exports = withHeadstartWPConfig(nextConfig);\n")),(0,i.kt)("admonition",{type:"info"},(0,i.kt)("p",{parentName:"admonition"},"The HeadstartWP ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/tree/develop/projects/wp-nextjs"},"scaffold")," already includes the code above")),(0,i.kt)("p",null,"The code above checks for ",(0,i.kt)("inlineCode",{parentName:"p"},"NEXT_REDIS_URL")," and ",(0,i.kt)("inlineCode",{parentName:"p"},"VIP_REDIS_PRIMARY")," (which is specific for WordPress VIP hosting), however there are several other env variables you can use to configure your redis connection."),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_URL"),": It's the simplest way to set up your redis connection, simply pass the full redis connection string."),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"VIP_REDIS_PRIMARY")," and ",(0,i.kt)("inlineCode",{parentName:"li"},"VIP_REDIS_PASSWORD"),": this is specific to WordPress VIP hosting, if Redis is enabled on VIP hosting these env variables will be automatically set for you so you do not need to add them yourself."),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_HOST"),", ",(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_PORT")," and ",(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_PASS"),": Instead of a full redis connection string you can specify the host, port and password separately."),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_SENTINEL_NAME"),", ",(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_SENTINEL_PASSWORD"),", ",(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_PASS"),": This is only needed if you want to connect to a redis sentinel cluster. If you do so, you also need to set the ",(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_HOST"),", ",(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_PORT")," and ",(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_PASS")," variables.")),(0,i.kt)("h3",{id:"purging-the-cdn-cache"},"Purging the CDN Cache"),(0,i.kt)("p",null,"Another thing you want to consider is flushing the CDN cache ",(0,i.kt)("strong",{parentName:"p"},"after")," you revalidate the page in Next.js. This can be done on the WordPress side by hooking up to the ",(0,i.kt)("inlineCode",{parentName:"p"},"tenup_headless_wp_revalidate")," action. This action is fired off after Next.js has finished revalidating the page."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-php"},"add_filter( 'tenup_headless_wp_revalidate', function( $post, $front_end_post_url ) {\n // $front_end_psot_url is the URL for the post with the front-end/headless url.\n function_to_clear_my_favorite_cdn_cache( $front_end_post_url );\n}, 10, 2 );\n")),(0,i.kt)("h4",{id:"a-note-about-wordpress-vip"},"A note about WordPress VIP"),(0,i.kt)("p",null,"If you are hosting on WordPress VIP the plugin already clears the VIP CDN cache, so you don't need to handle this yourself. The ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/develop/wp/headless-wp/includes/classes/CacheFlush/CacheFlush.php#L122C6-L122C6"},"following code")," is included in the plugin:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-php"},"if ( 200 === (int) $status_code && function_exists( 'wpcom_vip_purge_edge_cache_for_url' ) ) {\n wpcom_vip_purge_edge_cache_for_url( $headless_post_url );\n}\n")),(0,i.kt)("h3",{id:"revalidating-in-a-cron-job"},"Revalidating in a Cron Job"),(0,i.kt)("p",null,"If you prefer to run the revalidation logic in the background, you can tell the plugin to schedule a one-off cron job for immediate execution every time a post is saved. This can be enabled with the ",(0,i.kt)("inlineCode",{parentName:"p"},"tenup_headless_wp_revalidate_on_cron")," filter (it defaults to false)."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-php"},"add_filter( 'tenup_headless_wp_revalidate_on_cron', '___return_true' );\n")),(0,i.kt)("p",null,"This can be useful when the revalidation or the CDN cache purge is slow sp this can be used to speed up the post saving process."))}u.isMDXComponent=!0},7607:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/plugin-settings-cd21201c2690c652abab12a4be1b0e31.png"},5218:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/next-redis-cache-provider-fd13dd0eb17e43a3cd567dac08b80cd9.png"}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[825],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>g});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var l=a.createContext({}),d=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=d(e.components);return a.createElement(l.Provider,{value:t},e.children)},u="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=d(n),h=i,g=u["".concat(l,".").concat(h)]||u[h]||c[h]||r;return n?a.createElement(g,o(o({ref:t},p),{},{components:n})):a.createElement(g,o({ref:t},p))}));function g(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,o=new Array(r);o[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[u]="string"==typeof e?e:i,o[1]=s;for(var d=2;d{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>d});var a=n(7462),i=(n(7294),n(3905));const r={sidebar_position:2,slug:"/wordpress-integration/revalidate"},o="On-demand ISR revalidation",s={unversionedId:"WordPress Integration/revalidate",id:"WordPress Integration/revalidate",title:"On-demand ISR revalidation",description:"On-demand Revalidation is the ability to revalidate static pages programmatically from the CMS.",source:"@site/documentation/06-WordPress Integration/revalidate.md",sourceDirName:"06-WordPress Integration",slug:"/wordpress-integration/revalidate",permalink:"/docs/learn/wordpress-integration/revalidate",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/06-WordPress Integration/revalidate.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",sidebarPosition:2,frontMatter:{sidebar_position:2,slug:"/wordpress-integration/revalidate"},sidebar:"tutorialSidebar",previous:{title:"Multisite",permalink:"/docs/learn/wordpress-integration/multisite"},next:{title:"Basic Auth",permalink:"/docs/learn/wordpress-integration/basic-auth"}},l={},d=[{value:"Usage",id:"usage",level:2},{value:"Plugin setup",id:"plugin-setup",level:3},{value:"Revalidate Endpoint",id:"revalidate-endpoint",level:3},{value:"How does it work?",id:"how-does-it-work",level:2},{value:"Supporting Next.js ISR outside of Vercel",id:"supporting-nextjs-isr-outside-of-vercel",level:2},{value:"@10up/next-redis-cache-provider",id:"10upnext-redis-cache-provider",level:3},{value:"Purging the CDN Cache",id:"purging-the-cdn-cache",level:3},{value:"A note about WordPress VIP",id:"a-note-about-wordpress-vip",level:4},{value:"Revalidating in a Cron Job",id:"revalidating-in-a-cron-job",level:3}],p={toc:d};function u(e){let{components:t,...r}=e;return(0,i.kt)("wrapper",(0,a.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"on-demand-isr-revalidation"},"On-demand ISR revalidation"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/basic-features/data-fetching/incremental-static-regeneration#on-demand-revalidation"},"On-demand Revalidation")," is the ability to revalidate static pages programmatically from the CMS."),(0,i.kt)("p",null,"Without On-demand ISR revalidation users will need to wait until the time set in the ",(0,i.kt)("inlineCode",{parentName:"p"},"revalidate")," prop has passed before they can see an updated version of that page. This means that if a ",(0,i.kt)("inlineCode",{parentName:"p"},"revalidate")," is set to 5min, users would potentially have to wait up to 5min before they can see new content."),(0,i.kt)("p",null,'It is preferred to have the CMS ask the Next.js app to revalidate those pages when possible. This can be done via "On-Demand Revalidation".'),(0,i.kt)("p",null,"HeadstartWP supports Next.js ISR via the WordPress plugin and via ",(0,i.kt)("inlineCode",{parentName:"p"},"@10up/next-redis-cache-provider")," for hosts that do not natively support Next.js ISR (e.g. VIP, WPEngine etc)."),(0,i.kt)("h2",{id:"usage"},"Usage"),(0,i.kt)("h3",{id:"plugin-setup"},"Plugin setup"),(0,i.kt)("p",null,"HeadstartWP supports On-Demand Revalidation and it requires installing the WordPress Plugin. On-Demand Revalidation is opt-in and must be manually enabled in the plugin's settings (Settings -> General).\n",(0,i.kt)("img",{alt:"Plugin settings",src:n(7607).Z,width:"835",height:"270"})),(0,i.kt)("p",null,"The plugin expects the revalidate endpoint to live at ",(0,i.kt)("inlineCode",{parentName:"p"},"/api/revalidate"),". It is possible to customize this endpoint via the ",(0,i.kt)("inlineCode",{parentName:"p"},"tenup_headless_isr_revalidate_endpoint"),"."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-php"},"/**\n * Filters the revalidate endpoint.\n *\n * @param string $revalidate_endpoint The revalidate endpoint\n */\n$revalidate_endpoint = apply_filters( \n 'tenup_headless_isr_revalidate_endpoint', \n trailingslashit( Plugin::get_react_url() ) . 'api/revalidate' \n);\n")),(0,i.kt)("h3",{id:"revalidate-endpoint"},"Revalidate Endpoint"),(0,i.kt)("p",null,"Simply create a Next.js API endpoint that uses the ",(0,i.kt)("inlineCode",{parentName:"p"},"revalidateHandler")," provided by the framework. "),(0,i.kt)("admonition",{type:"caution"},(0,i.kt)("p",{parentName:"admonition"},"If you changed the default value of the endpoint path via the ",(0,i.kt)("inlineCode",{parentName:"p"},"tenup_headless_isr_revalidate_endpoint")," filter, make sure you change it in the Next.js app as well. ")),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-javascript",metastring:'title="src/pages/api/revalidate"',title:'"src/pages/api/revalidate"'},"import { revalidateHandler } from '@headstartwp/next';\n\n/**\n * The revalidate endpoint just needs to proxy the default revalidate handler\n *\n * @param {*} req Next.js request object\n * @param {*} res Next.js response object\n *\n * @returns\n */\nexport default async function handler(req, res) {\n return revalidateHandler(req, res);\n}\n")),(0,i.kt)("h2",{id:"how-does-it-work"},"How does it work?"),(0,i.kt)("p",null,"The default implementation will revalidate any post or page upon saving in WordPress. You can see the logic ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/develop/wp/headless-wp/includes/classes/CacheFlush/CacheFlush.php#L40"},"here"),"."),(0,i.kt)("h2",{id:"supporting-nextjs-isr-outside-of-vercel"},"Supporting Next.js ISR outside of Vercel"),(0,i.kt)("p",null,"If your host does not support Next.js ISR natively (e.g. WordPress VIP, WPEngine etc), ISR won't work well. If your hosting is serving your app via a traditional non-serverless setup using docker/kubernetes you most likely will run into issues trying to leverage Next.js ISR."),(0,i.kt)("p",null,"First off, if multiple containers are running to serve the requests to your website, a call to revalidate a particular page will only ever hit one of the containers that are running. This will lead to users being served by the containers that weren't hit by the WP call to still serve the old page. Even worse, the same user might be served by different containers and get both old and new responses for a page (e.g. the initial HTML is updated but the JSON associated with the page isn't)."),(0,i.kt)("p",null,"Officially, Next.js ",(0,i.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/pages/building-your-application/data-fetching/incremental-static-regeneration#self-hosting-isr"},"recommends")," sharing a writable volume across all the containers but that has some performance implications and some hosts simply don't support this setup."),(0,i.kt)("h3",{id:"10upnext-redis-cache-provider"},"@10up/next-redis-cache-provider"),(0,i.kt)("admonition",{type:"caution"},(0,i.kt)("p",{parentName:"admonition"},"If you are hosting on Vercel you do not need this package.")),(0,i.kt)("p",null,"Our solution to this problem has been to replace the filesystem cache with a redis cache provider. So whenever Next.js revalidates a page instead of storing the static page in disk, it will write to a shared redis instance that all of the containers would be talking to. The diagram below exemplifies how it works."),(0,i.kt)("p",null,(0,i.kt)("img",{alt:"Plugin settings",src:n(5218).Z,width:"2318",height:"819"})),(0,i.kt)("p",null,"To set up ",(0,i.kt)("inlineCode",{parentName:"p"},"@10up/next-redis-cache-provider")," first install it via npm:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-bash"},"npm install --save @10up/next-redis-cache-provider\n")),(0,i.kt)("p",null,"Then add it in ",(0,i.kt)("inlineCode",{parentName:"p"},"next.config.js"),":"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="next.config.js"',title:'"next.config.js"'},"const { withHeadstartWPConfig } = require('@headstartwp/next/config');\n\n/**\n * Update whatever you need within the nextConfig object.\n *\n * @type {import('next').NextConfig}\n */\nconst nextConfig = {\n eslint: {\n ignoreDuringBuilds: true,\n },\n};\n\n\nif (process.env.NEXT_REDIS_URL || process.env.VIP_REDIS_PRIMARY) {\n // eslint-disable-next-line global-require\n const { initRedisClient } = require('@10up/next-redis-cache-provider');\n initRedisClient();\n nextConfig.experimental = {\n incrementalCacheHandlerPath: require.resolve('@10up/next-redis-cache-provider'),\n };\n}\n\nmodule.exports = withHeadstartWPConfig(nextConfig);\n")),(0,i.kt)("admonition",{type:"info"},(0,i.kt)("p",{parentName:"admonition"},"The HeadstartWP ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/tree/develop/projects/wp-nextjs"},"scaffold")," already includes the code above")),(0,i.kt)("p",null,"The code above checks for ",(0,i.kt)("inlineCode",{parentName:"p"},"NEXT_REDIS_URL")," and ",(0,i.kt)("inlineCode",{parentName:"p"},"VIP_REDIS_PRIMARY")," (which is specific for WordPress VIP hosting), however there are several other env variables you can use to configure your redis connection."),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_URL"),": It's the simplest way to set up your redis connection, simply pass the full redis connection string."),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"VIP_REDIS_PRIMARY")," and ",(0,i.kt)("inlineCode",{parentName:"li"},"VIP_REDIS_PASSWORD"),": this is specific to WordPress VIP hosting, if Redis is enabled on VIP hosting these env variables will be automatically set for you so you do not need to add them yourself."),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_HOST"),", ",(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_PORT")," and ",(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_PASS"),": Instead of a full redis connection string you can specify the host, port and password separately."),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_SENTINEL_NAME"),", ",(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_SENTINEL_PASSWORD"),", ",(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_PASS"),": This is only needed if you want to connect to a redis sentinel cluster. If you do so, you also need to set the ",(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_HOST"),", ",(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_PORT")," and ",(0,i.kt)("inlineCode",{parentName:"li"},"NEXT_REDIS_PASS")," variables.")),(0,i.kt)("h3",{id:"purging-the-cdn-cache"},"Purging the CDN Cache"),(0,i.kt)("p",null,"Another thing you want to consider is flushing the CDN cache ",(0,i.kt)("strong",{parentName:"p"},"after")," you revalidate the page in Next.js. This can be done on the WordPress side by hooking up to the ",(0,i.kt)("inlineCode",{parentName:"p"},"tenup_headless_wp_revalidate")," action. This action is fired off after Next.js has finished revalidating the page."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-php"},"add_filter( 'tenup_headless_wp_revalidate', function( $post, $front_end_post_url ) {\n // $front_end_psot_url is the URL for the post with the front-end/headless url.\n function_to_clear_my_favorite_cdn_cache( $front_end_post_url );\n}, 10, 2 );\n")),(0,i.kt)("h4",{id:"a-note-about-wordpress-vip"},"A note about WordPress VIP"),(0,i.kt)("p",null,"If you are hosting on WordPress VIP the plugin already clears the VIP CDN cache, so you don't need to handle this yourself. The ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/develop/wp/headless-wp/includes/classes/CacheFlush/CacheFlush.php#L122C6-L122C6"},"following code")," is included in the plugin:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-php"},"if ( 200 === (int) $status_code && function_exists( 'wpcom_vip_purge_edge_cache_for_url' ) ) {\n wpcom_vip_purge_edge_cache_for_url( $headless_post_url );\n}\n")),(0,i.kt)("h3",{id:"revalidating-in-a-cron-job"},"Revalidating in a Cron Job"),(0,i.kt)("p",null,"If you prefer to run the revalidation logic in the background, you can tell the plugin to schedule a one-off cron job for immediate execution every time a post is saved. This can be enabled with the ",(0,i.kt)("inlineCode",{parentName:"p"},"tenup_headless_wp_revalidate_on_cron")," filter (it defaults to false)."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-php"},"add_filter( 'tenup_headless_wp_revalidate_on_cron', '___return_true' );\n")),(0,i.kt)("p",null,"This can be useful when the revalidation or the CDN cache purge is slow sp this can be used to speed up the post saving process."))}u.isMDXComponent=!0},7607:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/plugin-settings-cd21201c2690c652abab12a4be1b0e31.png"},5218:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/next-redis-cache-provider-fd13dd0eb17e43a3cd567dac08b80cd9.png"}}]); \ No newline at end of file diff --git a/assets/js/55dad7f7.1c038a95.js b/assets/js/55dad7f7.c4bbf2a0.js similarity index 99% rename from assets/js/55dad7f7.1c038a95.js rename to assets/js/55dad7f7.c4bbf2a0.js index 2a7ca12bf..9e63a7e12 100644 --- a/assets/js/55dad7f7.1c038a95.js +++ b/assets/js/55dad7f7.c4bbf2a0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3586],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>h});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var l=n.createContext({}),p=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},c=function(e){var t=p(e.components);return n.createElement(l.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=p(r),m=a,h=d["".concat(l,".").concat(m)]||d[m]||u[m]||o;return r?n.createElement(h,i(i({ref:t},c),{},{components:r})):n.createElement(h,i({ref:t},c))}));function h(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[d]="string"==typeof e?e:a,i[1]=s;for(var p=2;p{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const o={slug:"/utilities/sanitization",sidebar_label:"Escaping & Sanitization"},i="Escaping & Sanitization",s={unversionedId:"Utilities/sanitization",id:"Utilities/sanitization",title:"Escaping & Sanitization",description:"As you're probably aware, React won't render raw HTML by default. If you want to do so you must use dangerouslySetInnerHTML.",source:"@site/documentation/03- Utilities/sanitization.md",sourceDirName:"03- Utilities",slug:"/utilities/sanitization",permalink:"/docs/learn/utilities/sanitization",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/03- Utilities/sanitization.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",frontMatter:{slug:"/utilities/sanitization",sidebar_label:"Escaping & Sanitization"},sidebar:"tutorialSidebar",previous:{title:"Prefetching data on the server",permalink:"/docs/learn/data-fetching/prefetching"},next:{title:"Rendering Blocks",permalink:"/docs/learn/gutenberg/rendering-blocks"}},l={},p=[{value:"wpKsesPost",id:"wpksespost",level:2},{value:"stripTags",id:"striptags",level:2},{value:"BlocksRenderer",id:"blocksrenderer",level:2},{value:"HtmlDecoder",id:"htmldecoder",level:2},{value:"SafeHtml",id:"safehtml",level:2},{value:"decodeHtmlSpeciaChars",id:"decodehtmlspeciachars",level:2}],c={toc:p};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"escaping--sanitization"},"Escaping & Sanitization"),(0,a.kt)("p",null,"As you're probably aware, React won't render raw HTML by default. If you want to do so you must use ",(0,a.kt)("a",{parentName:"p",href:"https://react.dev/reference/react-dom/components/common#dangerously-setting-the-inner-html"},"dangerouslySetInnerHTML"),"."),(0,a.kt)("p",null,"This page describes some of the utility functions and components provided by the framework to help with escaping & sanitization when rendering raw markup."),(0,a.kt)("h2",{id:"wpksespost"},"wpKsesPost"),(0,a.kt)("p",null,"This function sanitizes HTML content with requirements similar to ",(0,a.kt)("a",{parentName:"p",href:"https://developer.wordpress.org/reference/functions/wp_kses_post/"},"wp_kses_post"),". If you are rendering arbitrary HTML markup you should probably run the markup through this function first."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-jsx"},"import { wpKsesPost } from '@headstartwp/core';\n\nconst markup = { __html: wpKsesPost('

some raw html

') };\nreturn
;\n")),(0,a.kt)("h2",{id:"striptags"},"stripTags"),(0,a.kt)("p",null,"This function simply strips any html tags from a string. This can be useful in contexts where you don't want any HTML to be rendered."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-jsx"},"import { stripTags } from '@headstartwp/core';\n\nreturn

{stripTags('this is a title without a span')}

;\n")),(0,a.kt)("h2",{id:"blocksrenderer"},"BlocksRenderer"),(0,a.kt)("p",null,"When using ",(0,a.kt)("a",{parentName:"p",href:"/learn/gutenberg/rendering-blocks"},"BlocksRenderer")," your markup already goes through ",(0,a.kt)("inlineCode",{parentName:"p"},"wpKsesPost")," so there's nothing else you need to worry about."),(0,a.kt)("h2",{id:"htmldecoder"},"HtmlDecoder"),(0,a.kt)("p",null,"Sometimes you might just want to decode some HTML entities without actually rendering any HTML tags. For this purpose you can use the ",(0,a.kt)("inlineCode",{parentName:"p"},"HtmlDecoder")," component."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-jsx"},"import { HtmlDecoder } from '@headstartwp/core/react';\n\n

\n \n

\n")),(0,a.kt)("h2",{id:"safehtml"},"SafeHtml"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"SafeHtml")," component provides an easy way to safely render HTML markup. It runs the markup through ",(0,a.kt)("inlineCode",{parentName:"p"},"wpKsesPost")," just like ",(0,a.kt)("inlineCode",{parentName:"p"},"BlocksRenderer"),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-jsx"},"import { SafeHtml } from '@headstartwp/core/react';\n\n

hello world

div content
\">\n")),(0,a.kt)("h2",{id:"decodehtmlspeciachars"},"decodeHtmlSpeciaChars"),(0,a.kt)("p",null,"This function will decode a pre-defined set of html special chars."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"import { decodeHtmlSpeciaChars } from '@headstartwp/core';\n\ndecodeHtmlSpeciaChars('Hello world! – foo bar –');\n")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3586],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>h});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var l=n.createContext({}),p=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},c=function(e){var t=p(e.components);return n.createElement(l.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=p(r),m=a,h=d["".concat(l,".").concat(m)]||d[m]||u[m]||o;return r?n.createElement(h,i(i({ref:t},c),{},{components:r})):n.createElement(h,i({ref:t},c))}));function h(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[d]="string"==typeof e?e:a,i[1]=s;for(var p=2;p{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const o={slug:"/utilities/sanitization",sidebar_label:"Escaping & Sanitization"},i="Escaping & Sanitization",s={unversionedId:"Utilities/sanitization",id:"Utilities/sanitization",title:"Escaping & Sanitization",description:"As you're probably aware, React won't render raw HTML by default. If you want to do so you must use dangerouslySetInnerHTML.",source:"@site/documentation/03- Utilities/sanitization.md",sourceDirName:"03- Utilities",slug:"/utilities/sanitization",permalink:"/docs/learn/utilities/sanitization",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/03- Utilities/sanitization.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",frontMatter:{slug:"/utilities/sanitization",sidebar_label:"Escaping & Sanitization"},sidebar:"tutorialSidebar",previous:{title:"Prefetching data on the server",permalink:"/docs/learn/data-fetching/prefetching"},next:{title:"Rendering Blocks",permalink:"/docs/learn/gutenberg/rendering-blocks"}},l={},p=[{value:"wpKsesPost",id:"wpksespost",level:2},{value:"stripTags",id:"striptags",level:2},{value:"BlocksRenderer",id:"blocksrenderer",level:2},{value:"HtmlDecoder",id:"htmldecoder",level:2},{value:"SafeHtml",id:"safehtml",level:2},{value:"decodeHtmlSpeciaChars",id:"decodehtmlspeciachars",level:2}],c={toc:p};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"escaping--sanitization"},"Escaping & Sanitization"),(0,a.kt)("p",null,"As you're probably aware, React won't render raw HTML by default. If you want to do so you must use ",(0,a.kt)("a",{parentName:"p",href:"https://react.dev/reference/react-dom/components/common#dangerously-setting-the-inner-html"},"dangerouslySetInnerHTML"),"."),(0,a.kt)("p",null,"This page describes some of the utility functions and components provided by the framework to help with escaping & sanitization when rendering raw markup."),(0,a.kt)("h2",{id:"wpksespost"},"wpKsesPost"),(0,a.kt)("p",null,"This function sanitizes HTML content with requirements similar to ",(0,a.kt)("a",{parentName:"p",href:"https://developer.wordpress.org/reference/functions/wp_kses_post/"},"wp_kses_post"),". If you are rendering arbitrary HTML markup you should probably run the markup through this function first."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-jsx"},"import { wpKsesPost } from '@headstartwp/core';\n\nconst markup = { __html: wpKsesPost('

some raw html

') };\nreturn
;\n")),(0,a.kt)("h2",{id:"striptags"},"stripTags"),(0,a.kt)("p",null,"This function simply strips any html tags from a string. This can be useful in contexts where you don't want any HTML to be rendered."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-jsx"},"import { stripTags } from '@headstartwp/core';\n\nreturn

{stripTags('this is a title without a span')}

;\n")),(0,a.kt)("h2",{id:"blocksrenderer"},"BlocksRenderer"),(0,a.kt)("p",null,"When using ",(0,a.kt)("a",{parentName:"p",href:"/learn/gutenberg/rendering-blocks"},"BlocksRenderer")," your markup already goes through ",(0,a.kt)("inlineCode",{parentName:"p"},"wpKsesPost")," so there's nothing else you need to worry about."),(0,a.kt)("h2",{id:"htmldecoder"},"HtmlDecoder"),(0,a.kt)("p",null,"Sometimes you might just want to decode some HTML entities without actually rendering any HTML tags. For this purpose you can use the ",(0,a.kt)("inlineCode",{parentName:"p"},"HtmlDecoder")," component."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-jsx"},"import { HtmlDecoder } from '@headstartwp/core/react';\n\n

\n \n

\n")),(0,a.kt)("h2",{id:"safehtml"},"SafeHtml"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"SafeHtml")," component provides an easy way to safely render HTML markup. It runs the markup through ",(0,a.kt)("inlineCode",{parentName:"p"},"wpKsesPost")," just like ",(0,a.kt)("inlineCode",{parentName:"p"},"BlocksRenderer"),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-jsx"},"import { SafeHtml } from '@headstartwp/core/react';\n\n

hello world

div content
\">\n")),(0,a.kt)("h2",{id:"decodehtmlspeciachars"},"decodeHtmlSpeciaChars"),(0,a.kt)("p",null,"This function will decode a pre-defined set of html special chars."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"import { decodeHtmlSpeciaChars } from '@headstartwp/core';\n\ndecodeHtmlSpeciaChars('Hello world! – foo bar –');\n")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/560f4e5a.4f644b19.js b/assets/js/560f4e5a.94266e8b.js similarity index 99% rename from assets/js/560f4e5a.4f644b19.js rename to assets/js/560f4e5a.94266e8b.js index 4a5b2a7bf..24da19912 100644 --- a/assets/js/560f4e5a.4f644b19.js +++ b/assets/js/560f4e5a.94266e8b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8247],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>u});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var d=n.createContext({}),p=function(e){var t=n.useContext(d),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=p(e.components);return n.createElement(d.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,d=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),c=p(r),m=a,u=c["".concat(d,".").concat(m)]||c[m]||k[m]||i;return r?n.createElement(u,l(l({ref:t},s),{},{components:r})):n.createElement(u,l({ref:t},s))}));function u(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,l=new Array(i);l[0]=m;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o[c]="string"==typeof e?e:a,l[1]=o;for(var p=2;p{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const i={id:"headstartwp_core.ConfigError",title:"Class: ConfigError",sidebar_label:"@headstartwp/core.ConfigError",custom_edit_url:null},l=void 0,o={unversionedId:"classes/headstartwp_core.ConfigError",id:"classes/headstartwp_core.ConfigError",title:"Class: ConfigError",description:"@headstartwp/core.ConfigError",source:"@site/docs/classes/headstartwp_core.ConfigError.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.ConfigError",permalink:"/docs/api/classes/headstartwp_core.ConfigError",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.ConfigError",title:"Class: ConfigError",sidebar_label:"@headstartwp/core.ConfigError",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.Comment",permalink:"/docs/api/classes/headstartwp_core.Comment"},next:{title:"@headstartwp/core.Element",permalink:"/docs/api/classes/headstartwp_core.Element"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"cause",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"stack",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"prepareStackTrace",id:"preparestacktrace",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],s={toc:p};function c(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".ConfigError"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"Error")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"ConfigError"))))),(0,a.kt)("h2",{id:"constructors"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new ConfigError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"message"),")"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,"Error.constructor"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/errors.ts#L18"},"packages/core/src/utils/errors.ts:18")),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"cause"},"cause"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"cause"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"Error.cause"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"message"},"message"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"message"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"Error.message"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1054"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,"Error.name"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1053"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"stack"},"stack"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"stack"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,"Error.stack"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1055"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:127"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"preparestacktrace"},"prepareStackTrace"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"prepareStackTrace"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"err"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"stackTraces"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"CallSite"),"[]) => ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"err"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"stackTraces"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("p",null,"Optional override for formatting stack traces"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"See"))),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces"},"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces")),(0,a.kt)("h5",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"err")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Error"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"stackTraces")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"CallSite"),"[]")))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"Error.prepareStackTrace"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:140"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"stacktracelimit"},"stackTraceLimit"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"stackTraceLimit"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,"Error.stackTraceLimit"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:142"),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"capturestacktrace"},"captureStackTrace"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"captureStackTrace"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"targetObject"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"constructorOpt?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"Create .stack property on a target object"),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"targetObject")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Object"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"constructorOpt?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Function"))))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,"Error.captureStackTrace"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:133"))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8247],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>u});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var d=n.createContext({}),p=function(e){var t=n.useContext(d),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=p(e.components);return n.createElement(d.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,d=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),c=p(r),m=a,u=c["".concat(d,".").concat(m)]||c[m]||k[m]||i;return r?n.createElement(u,l(l({ref:t},s),{},{components:r})):n.createElement(u,l({ref:t},s))}));function u(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,l=new Array(i);l[0]=m;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o[c]="string"==typeof e?e:a,l[1]=o;for(var p=2;p{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const i={id:"headstartwp_core.ConfigError",title:"Class: ConfigError",sidebar_label:"@headstartwp/core.ConfigError",custom_edit_url:null},l=void 0,o={unversionedId:"classes/headstartwp_core.ConfigError",id:"classes/headstartwp_core.ConfigError",title:"Class: ConfigError",description:"@headstartwp/core.ConfigError",source:"@site/docs/classes/headstartwp_core.ConfigError.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.ConfigError",permalink:"/docs/api/classes/headstartwp_core.ConfigError",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.ConfigError",title:"Class: ConfigError",sidebar_label:"@headstartwp/core.ConfigError",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.Comment",permalink:"/docs/api/classes/headstartwp_core.Comment"},next:{title:"@headstartwp/core.Element",permalink:"/docs/api/classes/headstartwp_core.Element"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"cause",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"stack",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"prepareStackTrace",id:"preparestacktrace",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],s={toc:p};function c(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".ConfigError"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"Error")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"ConfigError"))))),(0,a.kt)("h2",{id:"constructors"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new ConfigError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"message"),")"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,"Error.constructor"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/errors.ts#L18"},"packages/core/src/utils/errors.ts:18")),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"cause"},"cause"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"cause"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"Error.cause"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"message"},"message"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"message"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"Error.message"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1054"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,"Error.name"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1053"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"stack"},"stack"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"stack"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,"Error.stack"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1055"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:127"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"preparestacktrace"},"prepareStackTrace"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"prepareStackTrace"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"err"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"stackTraces"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"CallSite"),"[]) => ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"err"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"stackTraces"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("p",null,"Optional override for formatting stack traces"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"See"))),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces"},"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces")),(0,a.kt)("h5",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"err")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Error"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"stackTraces")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"CallSite"),"[]")))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"Error.prepareStackTrace"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:140"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"stacktracelimit"},"stackTraceLimit"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"stackTraceLimit"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,"Error.stackTraceLimit"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:142"),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"capturestacktrace"},"captureStackTrace"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"captureStackTrace"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"targetObject"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"constructorOpt?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"Create .stack property on a target object"),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"targetObject")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Object"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"constructorOpt?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Function"))))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,"Error.captureStackTrace"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:133"))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5667ca25.ff5e0b2d.js b/assets/js/5667ca25.3f7808ca.js similarity index 90% rename from assets/js/5667ca25.ff5e0b2d.js rename to assets/js/5667ca25.3f7808ca.js index 94f182c21..b8fa44925 100644 --- a/assets/js/5667ca25.ff5e0b2d.js +++ b/assets/js/5667ca25.3f7808ca.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1994],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var n=a(7294);function i(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function d(e){for(var t=1;t=0||(i[a]=e[a]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var s=n.createContext({}),l=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):d(d({},t),e)),a},o=function(e){var t=l(e.components);return n.createElement(s.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var a=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,o=p(e,["components","mdxType","originalType","parentName"]),c=l(a),m=i,k=c["".concat(s,".").concat(m)]||c[m]||h[m]||r;return a?n.createElement(k,d(d({ref:t},o),{},{components:a})):n.createElement(k,d({ref:t},o))}));function k(e,t){var a=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=a.length,d=new Array(r);d[0]=m;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[c]="string"==typeof e?e:i,d[1]=p;for(var l=2;l{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>d,default:()=>c,frontMatter:()=>r,metadata:()=>p,toc:()=>l});var n=a(7462),i=(a(7294),a(3905));const r={id:"headstartwp_core.AttachmentEntity",title:"Interface: AttachmentEntity",sidebar_label:"@headstartwp/core.AttachmentEntity",custom_edit_url:null},d=void 0,p={unversionedId:"interfaces/headstartwp_core.AttachmentEntity",id:"interfaces/headstartwp_core.AttachmentEntity",title:"Interface: AttachmentEntity",description:"@headstartwp/core.AttachmentEntity",source:"@site/docs/interfaces/headstartwp_core.AttachmentEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.AttachmentEntity",permalink:"/docs/api/interfaces/headstartwp_core.AttachmentEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.AttachmentEntity",title:"Interface: AttachmentEntity",sidebar_label:"@headstartwp/core.AttachmentEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.AppEntity",permalink:"/docs/api/interfaces/headstartwp_core.AppEntity"},next:{title:"@headstartwp/core.AuthorEntity",permalink:"/docs/api/interfaces/headstartwp_core.AuthorEntity"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embedded",id:"_embedded",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"alt_text",id:"alt_text",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"author",id:"author",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"caption",id:"caption",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"comment_status",id:"comment_status",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"date",id:"date",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"date_gmt",id:"date_gmt",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"guid",id:"guid",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"link",id:"link",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"media_details",id:"media_details",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"media_type",id:"media_type",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"meta",id:"meta",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"mime_type",id:"mime_type",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"missing_image_sizes",id:"missing_image_sizes",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"modified",id:"modified",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"modified_gmt",id:"modified_gmt",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"ping_status",id:"ping_status",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"post",id:"post",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"slug",id:"slug",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"source_url",id:"source_url",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"status",id:"status",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"template",id:"template",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"terms",id:"terms",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"type",id:"type",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-28",level:4}],o={toc:l};function c(e){let{components:t,...a}=e;return(0,i.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".AttachmentEntity"),(0,i.kt)("p",null,"Interface for entities from the /wp/v2/media endpoint."),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"PostTypeEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"AttachmentEntity"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"_embedded"},"_","embedded"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"_","embedded"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"author")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wp:term")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]")))),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#_embedded"},"_embedded")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L98"},"packages/core/src/data/types/entities.ts:98")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"alt_text"},"alt","_","text"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"alt","_","text"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Alternative text to display when attachment is not displayed."),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L259"},"packages/core/src/data/types/entities.ts:259")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"author"},"author"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"author"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#author"},"author")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L94"},"packages/core/src/data/types/entities.ts:94")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"caption"},"caption"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"caption"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The attachment caption."),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L264"},"packages/core/src/data/types/entities.ts:264")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"comment_status"},"comment","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"comment","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not comments are open on the object."),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#comment_status"},"comment_status")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L106"},"packages/core/src/data/types/entities.ts:106")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date"},"date"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date"},"date")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L42"},"packages/core/src/data/types/entities.ts:42")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date_gmt"},"date","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, as GMT."),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date_gmt"},"date_gmt")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L47"},"packages/core/src/data/types/entities.ts:47")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"description"},"description"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"description"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The attachment description."),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L269"},"packages/core/src/data/types/entities.ts:269")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"guid"},"guid"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"guid"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The globally unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#guid"},"guid")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L52"},"packages/core/src/data/types/entities.ts:52")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"id"},"id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#id"},"id")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L67"},"packages/core/src/data/types/entities.ts:67")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"link"},"link"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"link"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"URL to the object."),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#link"},"link")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L72"},"packages/core/src/data/types/entities.ts:72")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"media_details"},"media","_","details"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"media","_","details"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("p",null,"Details about the media file, specific to its type."),(0,i.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"file")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The file path relative to ",(0,i.kt)("inlineCode",{parentName:"td"},"wp-content/uploads"),".")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"height")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The height of the attachment.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"image_meta")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"unknown"),">"),(0,i.kt)("td",{parentName:"tr",align:"left"},"The metadata of the attachment.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"sizes")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"string"),", { ",(0,i.kt)("inlineCode",{parentName:"td"},"file"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"height"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"number")," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"mime_type"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"source_url"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"width"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"number")," }",">"),(0,i.kt)("td",{parentName:"tr",align:"left"},"The different sizes that WordPress created for this attachment.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"width")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The width of the attachment.")))),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L284"},"packages/core/src/data/types/entities.ts:284")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"media_type"},"media","_","type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"media","_","type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"image"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"file"')),(0,i.kt)("p",null,"Attachment type."),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L274"},"packages/core/src/data/types/entities.ts:274")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"meta"},"meta"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"meta"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,i.kt)("p",null,"Meta fields."),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L249"},"packages/core/src/data/types/entities.ts:249")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"mime_type"},"mime","_","type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"mime","_","type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The attachment MIME type."),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L279"},"packages/core/src/data/types/entities.ts:279")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"missing_image_sizes"},"missing","_","image","_","sizes"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"missing","_","image","_","sizes"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,i.kt)("p",null,"List of the missing image sizes of the attachment."),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L352"},"packages/core/src/data/types/entities.ts:352")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified"},"modified"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified"},"modified")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L57"},"packages/core/src/data/types/entities.ts:57")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified_gmt"},"modified","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, as GMT."),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified_gmt"},"modified_gmt")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L62"},"packages/core/src/data/types/entities.ts:62")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ping_status"},"ping","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ping","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not the object can be pinged."),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#ping_status"},"ping_status")),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L111"},"packages/core/src/data/types/entities.ts:111")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"post"},"post"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"post"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The ID for the associated post of the attachment."),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L342"},"packages/core/src/data/types/entities.ts:342")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"slug"},"slug"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"slug"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"An alphanumeric identifier for the object unique to its type."),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#slug"},"slug")),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L77"},"packages/core/src/data/types/entities.ts:77")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"source_url"},"source","_","url"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"source","_","url"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"URL to the original attachment file."),(0,i.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L347"},"packages/core/src/data/types/entities.ts:347")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"status"},"status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"publish"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"future"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"draft"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"pending"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"private"')),(0,i.kt)("p",null,"A named status for the object."),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#status"},"status")),(0,i.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L82"},"packages/core/src/data/types/entities.ts:82")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"template"},"template"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"template"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The theme file to use to display the object."),(0,i.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L254"},"packages/core/src/data/types/entities.ts:254")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"terms"},"terms"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"terms"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,i.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#terms"},"terms")),(0,i.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L96"},"packages/core/src/data/types/entities.ts:96")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The title for the object."),(0,i.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#title"},"title")),(0,i.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L92"},"packages/core/src/data/types/entities.ts:92")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"type"},"type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"attachment"')),(0,i.kt)("p",null,"Type of Post for the object."),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#type"},"type")),(0,i.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L244"},"packages/core/src/data/types/entities.ts:244")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head"},"yoast_head")),(0,i.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L114"},"packages/core/src/data/types/entities.ts:114")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head_json"},"yoast_head_json")),(0,i.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L113"},"packages/core/src/data/types/entities.ts:113")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1994],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var n=a(7294);function i(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(i[a]=e[a]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var s=n.createContext({}),l=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=l(e.components);return n.createElement(s.Provider,{value:t},e.children)},h="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var a=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),h=l(a),m=i,k=h["".concat(s,".").concat(m)]||h[m]||c[m]||r;return a?n.createElement(k,p(p({ref:t},o),{},{components:a})):n.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=a.length,p=new Array(r);p[0]=m;var d={};for(var s in t)hasOwnProperty.call(t,s)&&(d[s]=t[s]);d.originalType=e,d[h]="string"==typeof e?e:i,p[1]=d;for(var l=2;l{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>h,frontMatter:()=>r,metadata:()=>d,toc:()=>l});var n=a(7462),i=(a(7294),a(3905));const r={id:"headstartwp_core.AttachmentEntity",title:"Interface: AttachmentEntity",sidebar_label:"@headstartwp/core.AttachmentEntity",custom_edit_url:null},p=void 0,d={unversionedId:"interfaces/headstartwp_core.AttachmentEntity",id:"interfaces/headstartwp_core.AttachmentEntity",title:"Interface: AttachmentEntity",description:"@headstartwp/core.AttachmentEntity",source:"@site/docs/interfaces/headstartwp_core.AttachmentEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.AttachmentEntity",permalink:"/docs/api/interfaces/headstartwp_core.AttachmentEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.AttachmentEntity",title:"Interface: AttachmentEntity",sidebar_label:"@headstartwp/core.AttachmentEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.AppEntity",permalink:"/docs/api/interfaces/headstartwp_core.AppEntity"},next:{title:"@headstartwp/core.AuthorEntity",permalink:"/docs/api/interfaces/headstartwp_core.AuthorEntity"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embedded",id:"_embedded",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"alt_text",id:"alt_text",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"author",id:"author",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"caption",id:"caption",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"comment_status",id:"comment_status",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"date",id:"date",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"date_gmt",id:"date_gmt",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"guid",id:"guid",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"link",id:"link",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"media_details",id:"media_details",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"media_type",id:"media_type",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"meta",id:"meta",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"mime_type",id:"mime_type",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"missing_image_sizes",id:"missing_image_sizes",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"modified",id:"modified",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"modified_gmt",id:"modified_gmt",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"ping_status",id:"ping_status",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"post",id:"post",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"slug",id:"slug",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"source_url",id:"source_url",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"status",id:"status",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"template",id:"template",level:3},{value:"Defined in",id:"defined-in-23",level:4},{value:"terms",id:"terms",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"type",id:"type",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-26",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-27",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-28",level:4}],o={toc:l};function h(e){let{components:t,...a}=e;return(0,i.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".AttachmentEntity"),(0,i.kt)("p",null,"Interface for entities from the /wp/v2/media endpoint."),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"PostTypeEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"AttachmentEntity"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"_embedded"},"_","embedded"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"_","embedded"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"author")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wp:term")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]")))),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#_embedded"},"_embedded")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L98"},"packages/core/src/data/types/entities.ts:98")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"alt_text"},"alt","_","text"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"alt","_","text"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Alternative text to display when attachment is not displayed."),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L259"},"packages/core/src/data/types/entities.ts:259")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"author"},"author"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"author"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#author"},"author")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L94"},"packages/core/src/data/types/entities.ts:94")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"caption"},"caption"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"caption"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The attachment caption."),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L264"},"packages/core/src/data/types/entities.ts:264")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"comment_status"},"comment","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"comment","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not comments are open on the object."),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#comment_status"},"comment_status")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L106"},"packages/core/src/data/types/entities.ts:106")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date"},"date"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date"},"date")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L42"},"packages/core/src/data/types/entities.ts:42")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date_gmt"},"date","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, as GMT."),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date_gmt"},"date_gmt")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L47"},"packages/core/src/data/types/entities.ts:47")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"description"},"description"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"description"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The attachment description."),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L269"},"packages/core/src/data/types/entities.ts:269")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"guid"},"guid"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"guid"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The globally unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#guid"},"guid")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L52"},"packages/core/src/data/types/entities.ts:52")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"id"},"id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#id"},"id")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L67"},"packages/core/src/data/types/entities.ts:67")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"link"},"link"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"link"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"URL to the object."),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#link"},"link")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L72"},"packages/core/src/data/types/entities.ts:72")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"media_details"},"media","_","details"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"media","_","details"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("p",null,"Details about the media file, specific to its type."),(0,i.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"file")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The file path relative to ",(0,i.kt)("inlineCode",{parentName:"td"},"wp-content/uploads"),".")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"height")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The height of the attachment.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"image_meta")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"unknown"),">"),(0,i.kt)("td",{parentName:"tr",align:"left"},"The metadata of the attachment.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"sizes")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"td"},"string"),", { ",(0,i.kt)("inlineCode",{parentName:"td"},"file"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"height"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"number")," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"mime_type"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"source_url"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,i.kt)("inlineCode",{parentName:"td"},"width"),": ",(0,i.kt)("inlineCode",{parentName:"td"},"number")," }",">"),(0,i.kt)("td",{parentName:"tr",align:"left"},"The different sizes that WordPress created for this attachment.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"width")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"number")),(0,i.kt)("td",{parentName:"tr",align:"left"},"The width of the attachment.")))),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L284"},"packages/core/src/data/types/entities.ts:284")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"media_type"},"media","_","type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"media","_","type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"image"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"file"')),(0,i.kt)("p",null,"Attachment type."),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L274"},"packages/core/src/data/types/entities.ts:274")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"meta"},"meta"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"meta"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,i.kt)("p",null,"Meta fields."),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L249"},"packages/core/src/data/types/entities.ts:249")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"mime_type"},"mime","_","type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"mime","_","type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The attachment MIME type."),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L279"},"packages/core/src/data/types/entities.ts:279")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"missing_image_sizes"},"missing","_","image","_","sizes"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"missing","_","image","_","sizes"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,i.kt)("p",null,"List of the missing image sizes of the attachment."),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L352"},"packages/core/src/data/types/entities.ts:352")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified"},"modified"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified"},"modified")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L57"},"packages/core/src/data/types/entities.ts:57")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified_gmt"},"modified","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, as GMT."),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified_gmt"},"modified_gmt")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L62"},"packages/core/src/data/types/entities.ts:62")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ping_status"},"ping","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ping","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not the object can be pinged."),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#ping_status"},"ping_status")),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L111"},"packages/core/src/data/types/entities.ts:111")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"post"},"post"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"post"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The ID for the associated post of the attachment."),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L342"},"packages/core/src/data/types/entities.ts:342")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"slug"},"slug"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"slug"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"An alphanumeric identifier for the object unique to its type."),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#slug"},"slug")),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L77"},"packages/core/src/data/types/entities.ts:77")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"source_url"},"source","_","url"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"source","_","url"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"URL to the original attachment file."),(0,i.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L347"},"packages/core/src/data/types/entities.ts:347")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"status"},"status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"publish"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"future"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"draft"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"pending"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"private"')),(0,i.kt)("p",null,"A named status for the object."),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#status"},"status")),(0,i.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L82"},"packages/core/src/data/types/entities.ts:82")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"template"},"template"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"template"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The theme file to use to display the object."),(0,i.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L254"},"packages/core/src/data/types/entities.ts:254")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"terms"},"terms"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"terms"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,i.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#terms"},"terms")),(0,i.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L96"},"packages/core/src/data/types/entities.ts:96")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The title for the object."),(0,i.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#title"},"title")),(0,i.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L92"},"packages/core/src/data/types/entities.ts:92")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"type"},"type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"attachment"')),(0,i.kt)("p",null,"Type of Post for the object."),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#type"},"type")),(0,i.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L244"},"packages/core/src/data/types/entities.ts:244")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head"},"yoast_head")),(0,i.kt)("h4",{id:"defined-in-27"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L114"},"packages/core/src/data/types/entities.ts:114")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head_json"},"yoast_head_json")),(0,i.kt)("h4",{id:"defined-in-28"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L113"},"packages/core/src/data/types/entities.ts:113")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/58adf8aa.39bb8bd2.js b/assets/js/58adf8aa.c965db62.js similarity index 97% rename from assets/js/58adf8aa.39bb8bd2.js rename to assets/js/58adf8aa.c965db62.js index 4f4585f49..e3b5dfb4d 100644 --- a/assets/js/58adf8aa.39bb8bd2.js +++ b/assets/js/58adf8aa.c965db62.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3133],{3905:(e,t,r)=>{r.d(t,{Zo:()=>u,kt:()=>m});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var s=n.createContext({}),l=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},u=function(e){var t=l(e.components);return n.createElement(s.Provider,{value:t},e.children)},d="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},b=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,s=e.parentName,u=c(e,["components","mdxType","originalType","parentName"]),d=l(r),b=o,m=d["".concat(s,".").concat(b)]||d[b]||p[b]||a;return r?n.createElement(m,i(i({ref:t},u),{},{components:r})):n.createElement(m,i({ref:t},u))}));function m(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,i=new Array(a);i[0]=b;var c={};for(var s in t)hasOwnProperty.call(t,s)&&(c[s]=t[s]);c.originalType=e,c[d]="string"==typeof e?e:o,i[1]=c;for(var l=2;l{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>d,frontMatter:()=>a,metadata:()=>c,toc:()=>l});var n=r(7462),o=(r(7294),r(3905));const a={sidebar_label:"Rendering Custom Blocks",sidebar_position:1,slug:"/gutenberg/rendering-custom-blocks"},i="Rendering Custom Blocks",c={unversionedId:"Gutenberg/rendering-custom-blocks",id:"Gutenberg/rendering-custom-blocks",title:"Rendering Custom Blocks",description:"Custom Blocks can be handled in a very similar way. If you need to render your custom block as a react component you should make sure that the block exposes its data via the markup. You can do so by appending additional data to the data-wp-block-attrs attribute or serializing the data needed inside the block.",source:"@site/documentation/05-Gutenberg/rendering-custom-blocks.md",sourceDirName:"05-Gutenberg",slug:"/gutenberg/rendering-custom-blocks",permalink:"/docs/learn/gutenberg/rendering-custom-blocks",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/05-Gutenberg/rendering-custom-blocks.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",sidebarPosition:1,frontMatter:{sidebar_label:"Rendering Custom Blocks",sidebar_position:1,slug:"/gutenberg/rendering-custom-blocks"},sidebar:"tutorialSidebar",previous:{title:"Rendering Blocks",permalink:"/docs/learn/gutenberg/rendering-blocks"},next:{title:"Rendering Blocks in React Native",permalink:"/docs/learn/gutenberg/rendering-blocks-in-react-native"}},s={},l=[],u={toc:l};function d(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,n.Z)({},u,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"rendering-custom-blocks"},"Rendering Custom Blocks"),(0,o.kt)("p",null,"Custom Blocks can be handled in a very similar way. If you need to render your custom block as a react component you should make sure that the block exposes its data via the markup. You can do so by appending additional data to the ",(0,o.kt)("inlineCode",{parentName:"p"},"data-wp-block-attrs")," attribute or serializing the data needed inside the block."))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3133],{3905:(e,t,r)=>{r.d(t,{Zo:()=>u,kt:()=>m});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var s=n.createContext({}),l=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},u=function(e){var t=l(e.components);return n.createElement(s.Provider,{value:t},e.children)},d="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},b=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,s=e.parentName,u=c(e,["components","mdxType","originalType","parentName"]),d=l(r),b=o,m=d["".concat(s,".").concat(b)]||d[b]||p[b]||a;return r?n.createElement(m,i(i({ref:t},u),{},{components:r})):n.createElement(m,i({ref:t},u))}));function m(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,i=new Array(a);i[0]=b;var c={};for(var s in t)hasOwnProperty.call(t,s)&&(c[s]=t[s]);c.originalType=e,c[d]="string"==typeof e?e:o,i[1]=c;for(var l=2;l{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>d,frontMatter:()=>a,metadata:()=>c,toc:()=>l});var n=r(7462),o=(r(7294),r(3905));const a={sidebar_label:"Rendering Custom Blocks",sidebar_position:1,slug:"/gutenberg/rendering-custom-blocks"},i="Rendering Custom Blocks",c={unversionedId:"Gutenberg/rendering-custom-blocks",id:"Gutenberg/rendering-custom-blocks",title:"Rendering Custom Blocks",description:"Custom Blocks can be handled in a very similar way. If you need to render your custom block as a react component you should make sure that the block exposes its data via the markup. You can do so by appending additional data to the data-wp-block-attrs attribute or serializing the data needed inside the block.",source:"@site/documentation/05-Gutenberg/rendering-custom-blocks.md",sourceDirName:"05-Gutenberg",slug:"/gutenberg/rendering-custom-blocks",permalink:"/docs/learn/gutenberg/rendering-custom-blocks",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/05-Gutenberg/rendering-custom-blocks.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",sidebarPosition:1,frontMatter:{sidebar_label:"Rendering Custom Blocks",sidebar_position:1,slug:"/gutenberg/rendering-custom-blocks"},sidebar:"tutorialSidebar",previous:{title:"Rendering Blocks",permalink:"/docs/learn/gutenberg/rendering-blocks"},next:{title:"Rendering Blocks in React Native",permalink:"/docs/learn/gutenberg/rendering-blocks-in-react-native"}},s={},l=[],u={toc:l};function d(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,n.Z)({},u,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"rendering-custom-blocks"},"Rendering Custom Blocks"),(0,o.kt)("p",null,"Custom Blocks can be handled in a very similar way. If you need to render your custom block as a react component you should make sure that the block exposes its data via the markup. You can do so by appending additional data to the ",(0,o.kt)("inlineCode",{parentName:"p"},"data-wp-block-attrs")," attribute or serializing the data needed inside the block."))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/58e6d968.1a8d4c0c.js b/assets/js/58e6d968.12a828dd.js similarity index 94% rename from assets/js/58e6d968.1a8d4c0c.js rename to assets/js/58e6d968.12a828dd.js index fb6695bff..530d73856 100644 --- a/assets/js/58e6d968.1a8d4c0c.js +++ b/assets/js/58e6d968.12a828dd.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[223],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>m});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var s=r.createContext({}),d=function(e){var t=r.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},c=function(e){var t=d(e.components);return r.createElement(s.Provider,{value:t},e.children)},o="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,s=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),o=d(a),u=n,m=o["".concat(s,".").concat(u)]||o[u]||h[u]||i;return a?r.createElement(m,p(p({ref:t},c),{},{components:a})):r.createElement(m,p({ref:t},c))}));function m(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=u;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[o]="string"==typeof e?e:n,p[1]=l;for(var d=2;d{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>o,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.SearchParams",title:"Interface: SearchParams",sidebar_label:"@headstartwp/core.SearchParams",custom_edit_url:null},p=void 0,l={unversionedId:"interfaces/headstartwp_core.SearchParams",id:"interfaces/headstartwp_core.SearchParams",title:"Interface: SearchParams",description:"@headstartwp/core.SearchParams",source:"@site/docs/interfaces/headstartwp_core.SearchParams.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.SearchParams",permalink:"/docs/api/interfaces/headstartwp_core.SearchParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.SearchParams",title:"Interface: SearchParams",sidebar_label:"@headstartwp/core.SearchParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.SearchObjectEntity",permalink:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},next:{title:"@headstartwp/core.TaxonomyArchiveParams",permalink:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"}},s={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embed",id:"_embed",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"_fields",id:"_fields",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"exclude",id:"exclude",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"include",id:"include",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"lang",id:"lang",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"page",id:"page",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"per_page",id:"per_page",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"search",id:"search",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"subtype",id:"subtype",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-9",level:4}],c={toc:d};function o(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".SearchParams"),(0,n.kt)("p",null,"The EndpointParams supported by the ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.SearchNativeFetchStrategy"},"SearchNativeFetchStrategy")),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"SearchParams"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"_embed"},"_","embed"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","embed"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"The _embed param returned associated entities in the response"),(0,n.kt)("p",null,"It's recommended to avoid additional requests to fetch data"),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_embed"},"_embed")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L17"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:17")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"_fields"},"_","fields"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","fields"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The _fields parameter is used to return only the specified fields in the response"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_fields"},"_fields")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L22"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:22")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,n.kt)("p",null,"Ensure result set excludes specific IDs."),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SearchNativeFetchStrategy.ts#L47"},"packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:47")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"include"},"include"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"include"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,n.kt)("p",null,"Limit result set to specific IDs."),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SearchNativeFetchStrategy.ts#L52"},"packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:52")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"lang"},"lang"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"lang"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The polylang ?lang parameter."),(0,n.kt)("p",null,"This is only used if the polylang integration is enabled"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#lang"},"lang")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L29"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:29")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"page"},"page"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"page"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"Current page of the collection."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,n.kt)("p",null,"1"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SearchNativeFetchStrategy.ts#L18"},"packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:18")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"per_page"},"per","_","page"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"per","_","page"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"Maximum number of items to be returned in result set."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,n.kt)("p",null,"10"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SearchNativeFetchStrategy.ts#L25"},"packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:25")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"search"},"search"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"search"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Limit results to those matching a string."),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SearchNativeFetchStrategy.ts#L30"},"packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:30")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"subtype"},"subtype"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"subtype"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"Limit results to items of one or more object subtypes."),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SearchNativeFetchStrategy.ts#L42"},"packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:42")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"type"},"type"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"type"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"post"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"term"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"post-format"')),(0,n.kt)("p",null,"Limit results to items of an object type."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,n.kt)("p",null,"'post'"),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SearchNativeFetchStrategy.ts#L37"},"packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:37")))}o.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[223],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>m});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var s=r.createContext({}),d=function(e){var t=r.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},c=function(e){var t=d(e.components);return r.createElement(s.Provider,{value:t},e.children)},o="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,s=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),o=d(a),u=n,m=o["".concat(s,".").concat(u)]||o[u]||h[u]||i;return a?r.createElement(m,p(p({ref:t},c),{},{components:a})):r.createElement(m,p({ref:t},c))}));function m(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=u;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[o]="string"==typeof e?e:n,p[1]=l;for(var d=2;d{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>o,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.SearchParams",title:"Interface: SearchParams",sidebar_label:"@headstartwp/core.SearchParams",custom_edit_url:null},p=void 0,l={unversionedId:"interfaces/headstartwp_core.SearchParams",id:"interfaces/headstartwp_core.SearchParams",title:"Interface: SearchParams",description:"@headstartwp/core.SearchParams",source:"@site/docs/interfaces/headstartwp_core.SearchParams.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.SearchParams",permalink:"/docs/api/interfaces/headstartwp_core.SearchParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.SearchParams",title:"Interface: SearchParams",sidebar_label:"@headstartwp/core.SearchParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.SearchObjectEntity",permalink:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},next:{title:"@headstartwp/core.TaxonomyArchiveParams",permalink:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"}},s={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embed",id:"_embed",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"_fields",id:"_fields",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"exclude",id:"exclude",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"include",id:"include",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"lang",id:"lang",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"page",id:"page",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"per_page",id:"per_page",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"search",id:"search",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"subtype",id:"subtype",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-9",level:4}],c={toc:d};function o(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".SearchParams"),(0,n.kt)("p",null,"The EndpointParams supported by the ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.SearchNativeFetchStrategy"},"SearchNativeFetchStrategy")),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"SearchParams"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"_embed"},"_","embed"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","embed"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"The _embed param returned associated entities in the response"),(0,n.kt)("p",null,"It's recommended to avoid additional requests to fetch data"),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_embed"},"_embed")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L17"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:17")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"_fields"},"_","fields"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","fields"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The _fields parameter is used to return only the specified fields in the response"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_fields"},"_fields")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L22"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:22")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,n.kt)("p",null,"Ensure result set excludes specific IDs."),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SearchNativeFetchStrategy.ts#L47"},"packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:47")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"include"},"include"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"include"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,n.kt)("p",null,"Limit result set to specific IDs."),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SearchNativeFetchStrategy.ts#L52"},"packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:52")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"lang"},"lang"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"lang"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The polylang ?lang parameter."),(0,n.kt)("p",null,"This is only used if the polylang integration is enabled"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#lang"},"lang")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L29"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:29")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"page"},"page"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"page"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"Current page of the collection."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,n.kt)("p",null,"1"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SearchNativeFetchStrategy.ts#L18"},"packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:18")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"per_page"},"per","_","page"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"per","_","page"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"Maximum number of items to be returned in result set."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,n.kt)("p",null,"10"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SearchNativeFetchStrategy.ts#L25"},"packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:25")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"search"},"search"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"search"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Limit results to those matching a string."),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SearchNativeFetchStrategy.ts#L30"},"packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:30")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"subtype"},"subtype"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"subtype"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"Limit results to items of one or more object subtypes."),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SearchNativeFetchStrategy.ts#L42"},"packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:42")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"type"},"type"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"type"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"post"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"term"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"post-format"')),(0,n.kt)("p",null,"Limit results to items of an object type."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"Default"))),(0,n.kt)("p",null,"'post'"),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SearchNativeFetchStrategy.ts#L37"},"packages/core/src/data/strategies/SearchNativeFetchStrategy.ts:37")))}o.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5a4180a9.24ea09cb.js b/assets/js/5a4180a9.ef3873e8.js similarity index 97% rename from assets/js/5a4180a9.24ea09cb.js rename to assets/js/5a4180a9.ef3873e8.js index d4cabc55b..3fd2e131b 100644 --- a/assets/js/5a4180a9.24ea09cb.js +++ b/assets/js/5a4180a9.ef3873e8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9589],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>g});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),u=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=u(e.components);return r.createElement(l.Provider,{value:t},e.children)},c="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),c=u(n),m=a,g=c["".concat(l,".").concat(m)]||c[m]||d[m]||i;return n?r.createElement(g,o(o({ref:t},p),{},{components:n})):r.createElement(g,o({ref:t},p))}));function g(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[c]="string"==typeof e?e:a,o[1]=s;for(var u=2;u{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>u});var r=n(7462),a=(n(7294),n(3905));const i={sidebar_label:"Quick Setup",slug:"/getting-started/quick-setup",sidebar_position:0},o="Quick Setup",s={unversionedId:"Getting Started/quick-setup",id:"Getting Started/quick-setup",title:"Quick Setup",description:"If you're new to Next.js, we recommend reviewing Next.js docs.",source:"@site/documentation/01-Getting Started/quick-setup.md",sourceDirName:"01-Getting Started",slug:"/getting-started/quick-setup",permalink:"/docs/learn/getting-started/quick-setup",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/01-Getting Started/quick-setup.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",sidebarPosition:0,frontMatter:{sidebar_label:"Quick Setup",slug:"/getting-started/quick-setup",sidebar_position:0},sidebar:"tutorialSidebar",previous:{title:"Introduction",permalink:"/docs/learn/"},next:{title:"Setting up the framework from scratch",permalink:"/docs/learn/getting-started/setting-up-manually"}},l={},u=[{value:"System Requirements",id:"system-requirements",level:2},{value:"Installation",id:"installation",level:2},{value:"Environment Variables",id:"environment-variables",level:3},{value:"Something Missing?",id:"something-missing",level:2}],p={toc:u};function c(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"quick-setup"},"Quick Setup"),(0,a.kt)("p",null,"If you're new to Next.js, we recommend reviewing ",(0,a.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/getting-started"},"Next.js docs"),"."),(0,a.kt)("h2",{id:"system-requirements"},"System Requirements"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Node.js 16 or later"),(0,a.kt)("li",{parentName:"ul"},"NPM >= 7"),(0,a.kt)("li",{parentName:"ul"},"WordPress >= 5.9 (prior versions might work but haven't been tested).")),(0,a.kt)("h2",{id:"installation"},"Installation"),(0,a.kt)("p",null,"The easiest way to get started with HeadstartWP is by using ",(0,a.kt)("inlineCode",{parentName:"p"},"create-next-app")," with the official starter project."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-bash"},"npx create-next-app --use-npm -e https://github.com/10up/headstartwp/tree/trunk/projects/wp-nextjs\n")),(0,a.kt)("p",null,"Then run ",(0,a.kt)("inlineCode",{parentName:"p"},"npm run dev")," and open http://localhost:3000 in your browser."),(0,a.kt)("h3",{id:"environment-variables"},"Environment Variables"),(0,a.kt)("p",null,"By default, the starter project will point to ",(0,a.kt)("inlineCode",{parentName:"p"},"js1.10up.com"),". Either change the\n",(0,a.kt)("inlineCode",{parentName:"p"},"NEXT_PUBLIC_HEADLESS_WP_URL")," variable or create a ",(0,a.kt)("inlineCode",{parentName:"p"},".env.local")," file to override the default env variables."),(0,a.kt)("p",null,"If you're developing locally and using HTTPS with WordPress and you don't have valid certs, you will need to add ",(0,a.kt)("inlineCode",{parentName:"p"},"NODE_TLS_REJECT_UNAUTHORIZED=0")," as an env variable"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"NEXT_PUBLIC_HEADLESS_WP_URL=https://wordpress.test\nNODE_TLS_REJECT_UNAUTHORIZED=0\n")),(0,a.kt)("h2",{id:"something-missing"},"Something Missing?"),(0,a.kt)("p",null,"If something is missing in the documentation or if you found some part confusing, please file an ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/issues"},"issue")," for the documentation repository with your suggestions for improvement."))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9589],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>g});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),u=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},p=function(e){var t=u(e.components);return r.createElement(l.Provider,{value:t},e.children)},c="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),c=u(n),m=a,g=c["".concat(l,".").concat(m)]||c[m]||d[m]||i;return n?r.createElement(g,o(o({ref:t},p),{},{components:n})):r.createElement(g,o({ref:t},p))}));function g(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[c]="string"==typeof e?e:a,o[1]=s;for(var u=2;u{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>u});var r=n(7462),a=(n(7294),n(3905));const i={sidebar_label:"Quick Setup",slug:"/getting-started/quick-setup",sidebar_position:0},o="Quick Setup",s={unversionedId:"Getting Started/quick-setup",id:"Getting Started/quick-setup",title:"Quick Setup",description:"If you're new to Next.js, we recommend reviewing Next.js docs.",source:"@site/documentation/01-Getting Started/quick-setup.md",sourceDirName:"01-Getting Started",slug:"/getting-started/quick-setup",permalink:"/docs/learn/getting-started/quick-setup",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/01-Getting Started/quick-setup.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",sidebarPosition:0,frontMatter:{sidebar_label:"Quick Setup",slug:"/getting-started/quick-setup",sidebar_position:0},sidebar:"tutorialSidebar",previous:{title:"Introduction",permalink:"/docs/learn/"},next:{title:"Setting up the framework from scratch",permalink:"/docs/learn/getting-started/setting-up-manually"}},l={},u=[{value:"System Requirements",id:"system-requirements",level:2},{value:"Installation",id:"installation",level:2},{value:"Environment Variables",id:"environment-variables",level:3},{value:"Something Missing?",id:"something-missing",level:2}],p={toc:u};function c(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"quick-setup"},"Quick Setup"),(0,a.kt)("p",null,"If you're new to Next.js, we recommend reviewing ",(0,a.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/getting-started"},"Next.js docs"),"."),(0,a.kt)("h2",{id:"system-requirements"},"System Requirements"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Node.js 16 or later"),(0,a.kt)("li",{parentName:"ul"},"NPM >= 7"),(0,a.kt)("li",{parentName:"ul"},"WordPress >= 5.9 (prior versions might work but haven't been tested).")),(0,a.kt)("h2",{id:"installation"},"Installation"),(0,a.kt)("p",null,"The easiest way to get started with HeadstartWP is by using ",(0,a.kt)("inlineCode",{parentName:"p"},"create-next-app")," with the official starter project."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-bash"},"npx create-next-app --use-npm -e https://github.com/10up/headstartwp/tree/trunk/projects/wp-nextjs\n")),(0,a.kt)("p",null,"Then run ",(0,a.kt)("inlineCode",{parentName:"p"},"npm run dev")," and open http://localhost:3000 in your browser."),(0,a.kt)("h3",{id:"environment-variables"},"Environment Variables"),(0,a.kt)("p",null,"By default, the starter project will point to ",(0,a.kt)("inlineCode",{parentName:"p"},"js1.10up.com"),". Either change the\n",(0,a.kt)("inlineCode",{parentName:"p"},"NEXT_PUBLIC_HEADLESS_WP_URL")," variable or create a ",(0,a.kt)("inlineCode",{parentName:"p"},".env.local")," file to override the default env variables."),(0,a.kt)("p",null,"If you're developing locally and using HTTPS with WordPress and you don't have valid certs, you will need to add ",(0,a.kt)("inlineCode",{parentName:"p"},"NODE_TLS_REJECT_UNAUTHORIZED=0")," as an env variable"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"NEXT_PUBLIC_HEADLESS_WP_URL=https://wordpress.test\nNODE_TLS_REJECT_UNAUTHORIZED=0\n")),(0,a.kt)("h2",{id:"something-missing"},"Something Missing?"),(0,a.kt)("p",null,"If something is missing in the documentation or if you found some part confusing, please file an ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/issues"},"issue")," for the documentation repository with your suggestions for improvement."))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5bda4233.eb8da348.js b/assets/js/5bda4233.80a677e4.js similarity index 90% rename from assets/js/5bda4233.eb8da348.js rename to assets/js/5bda4233.80a677e4.js index 25230c5ee..0c9d37bca 100644 --- a/assets/js/5bda4233.eb8da348.js +++ b/assets/js/5bda4233.80a677e4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6815],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>m});var n=a(7294);function i(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function d(e){for(var t=1;t=0||(i[a]=e[a]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var s=n.createContext({}),l=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):d(d({},t),e)),a},o=function(e){var t=l(e.components);return n.createElement(s.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,o=p(e,["components","mdxType","originalType","parentName"]),c=l(a),k=i,m=c["".concat(s,".").concat(k)]||c[k]||h[k]||r;return a?n.createElement(m,d(d({ref:t},o),{},{components:a})):n.createElement(m,d({ref:t},o))}));function m(e,t){var a=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=a.length,d=new Array(r);d[0]=k;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[c]="string"==typeof e?e:i,d[1]=p;for(var l=2;l{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>d,default:()=>c,frontMatter:()=>r,metadata:()=>p,toc:()=>l});var n=a(7462),i=(a(7294),a(3905));const r={id:"headstartwp_core.PostEntity",title:"Interface: PostEntity",sidebar_label:"@headstartwp/core.PostEntity",custom_edit_url:null},d=void 0,p={unversionedId:"interfaces/headstartwp_core.PostEntity",id:"interfaces/headstartwp_core.PostEntity",title:"Interface: PostEntity",description:"@headstartwp/core.PostEntity",source:"@site/docs/interfaces/headstartwp_core.PostEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PostEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostEntity",title:"Interface: PostEntity",sidebar_label:"@headstartwp/core.PostEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PolylangIntegration",permalink:"/docs/api/interfaces/headstartwp_core.PolylangIntegration"},next:{title:"@headstartwp/core.PostOrPostsParams",permalink:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embedded",id:"_embedded",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"author",id:"author",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"categories",id:"categories",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"comment_status",id:"comment_status",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"content",id:"content",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"date",id:"date",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"date_gmt",id:"date_gmt",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"excerpt",id:"excerpt",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"featured_media",id:"featured_media",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"format",id:"format",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"guid",id:"guid",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"link",id:"link",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"meta",id:"meta",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"modified",id:"modified",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"modified_gmt",id:"modified_gmt",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"ping_status",id:"ping_status",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"slug",id:"slug",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"status",id:"status",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"sticky",id:"sticky",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"tags",id:"tags",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"template",id:"template",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"terms",id:"terms",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"type",id:"type",level:3},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-26",level:4}],o={toc:l};function c(e){let{components:t,...a}=e;return(0,i.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostEntity"),(0,i.kt)("p",null,"Interface for entities from the /wp/v2/posts endpoint."),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"PostTypeEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"PostEntity"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"_embedded"},"_","embedded"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"_","embedded"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"author")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wp:term")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]")))),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#_embedded"},"_embedded")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L98"},"packages/core/src/data/types/entities.ts:98")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"author"},"author"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"author"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#author"},"author")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L94"},"packages/core/src/data/types/entities.ts:94")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"categories"},"categories"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"categories"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,i.kt)("p",null,"The terms assigned to the object in the category taxonomy."),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L164"},"packages/core/src/data/types/entities.ts:164")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"comment_status"},"comment","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"comment","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not comments are open on the object."),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#comment_status"},"comment_status")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L106"},"packages/core/src/data/types/entities.ts:106")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"content"},"content"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"content"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The content for the object."),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L124"},"packages/core/src/data/types/entities.ts:124")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date"},"date"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date"},"date")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L42"},"packages/core/src/data/types/entities.ts:42")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date_gmt"},"date","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, as GMT."),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date_gmt"},"date_gmt")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L47"},"packages/core/src/data/types/entities.ts:47")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"excerpt"},"excerpt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"excerpt"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The excerpt for the object."),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L129"},"packages/core/src/data/types/entities.ts:129")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"featured_media"},"featured","_","media"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"featured","_","media"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The ID of the featured media for the object."),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L174"},"packages/core/src/data/types/entities.ts:174")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"format"},"format"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"format"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"link"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"status"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"standard"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"aside"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"chat"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"gallery"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"image"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"quote"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"video"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"audio"')),(0,i.kt)("p",null,"The format for the object."),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L134"},"packages/core/src/data/types/entities.ts:134")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"guid"},"guid"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"guid"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The globally unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#guid"},"guid")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L52"},"packages/core/src/data/types/entities.ts:52")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"id"},"id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#id"},"id")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L67"},"packages/core/src/data/types/entities.ts:67")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"link"},"link"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"link"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"URL to the object."),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#link"},"link")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L72"},"packages/core/src/data/types/entities.ts:72")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"meta"},"meta"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"meta"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,i.kt)("p",null,"Meta fields."),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L149"},"packages/core/src/data/types/entities.ts:149")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified"},"modified"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified"},"modified")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L57"},"packages/core/src/data/types/entities.ts:57")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified_gmt"},"modified","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, as GMT."),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified_gmt"},"modified_gmt")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L62"},"packages/core/src/data/types/entities.ts:62")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ping_status"},"ping","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ping","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not the object can be pinged."),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#ping_status"},"ping_status")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L111"},"packages/core/src/data/types/entities.ts:111")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"slug"},"slug"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"slug"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"An alphanumeric identifier for the object unique to its type."),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#slug"},"slug")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L77"},"packages/core/src/data/types/entities.ts:77")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"status"},"status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"publish"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"future"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"draft"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"pending"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"private"')),(0,i.kt)("p",null,"A named status for the object."),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#status"},"status")),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L82"},"packages/core/src/data/types/entities.ts:82")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"sticky"},"sticky"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"sticky"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Whether or not the object should be treated as sticky."),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L154"},"packages/core/src/data/types/entities.ts:154")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"tags"},"tags"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"tags"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,i.kt)("p",null,"The terms assigned to the object in the post_tag taxonomy."),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L169"},"packages/core/src/data/types/entities.ts:169")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"template"},"template"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"template"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The theme file to use to display the object."),(0,i.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L159"},"packages/core/src/data/types/entities.ts:159")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"terms"},"terms"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"terms"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,i.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#terms"},"terms")),(0,i.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L96"},"packages/core/src/data/types/entities.ts:96")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The title for the object."),(0,i.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#title"},"title")),(0,i.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L92"},"packages/core/src/data/types/entities.ts:92")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"type"},"type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Type of Post for the object."),(0,i.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#type"},"type")),(0,i.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L87"},"packages/core/src/data/types/entities.ts:87")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head"},"yoast_head")),(0,i.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L114"},"packages/core/src/data/types/entities.ts:114")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head_json"},"yoast_head_json")),(0,i.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L113"},"packages/core/src/data/types/entities.ts:113")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6815],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>m});var n=a(7294);function i(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(i[a]=e[a]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var s=n.createContext({}),l=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=l(e.components);return n.createElement(s.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),c=l(a),k=i,m=c["".concat(s,".").concat(k)]||c[k]||h[k]||r;return a?n.createElement(m,p(p({ref:t},o),{},{components:a})):n.createElement(m,p({ref:t},o))}));function m(e,t){var a=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=a.length,p=new Array(r);p[0]=k;var d={};for(var s in t)hasOwnProperty.call(t,s)&&(d[s]=t[s]);d.originalType=e,d[c]="string"==typeof e?e:i,p[1]=d;for(var l=2;l{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>c,frontMatter:()=>r,metadata:()=>d,toc:()=>l});var n=a(7462),i=(a(7294),a(3905));const r={id:"headstartwp_core.PostEntity",title:"Interface: PostEntity",sidebar_label:"@headstartwp/core.PostEntity",custom_edit_url:null},p=void 0,d={unversionedId:"interfaces/headstartwp_core.PostEntity",id:"interfaces/headstartwp_core.PostEntity",title:"Interface: PostEntity",description:"@headstartwp/core.PostEntity",source:"@site/docs/interfaces/headstartwp_core.PostEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PostEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostEntity",title:"Interface: PostEntity",sidebar_label:"@headstartwp/core.PostEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PolylangIntegration",permalink:"/docs/api/interfaces/headstartwp_core.PolylangIntegration"},next:{title:"@headstartwp/core.PostOrPostsParams",permalink:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embedded",id:"_embedded",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"author",id:"author",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"categories",id:"categories",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"comment_status",id:"comment_status",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"content",id:"content",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"date",id:"date",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"date_gmt",id:"date_gmt",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"excerpt",id:"excerpt",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"featured_media",id:"featured_media",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"format",id:"format",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"guid",id:"guid",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"link",id:"link",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"meta",id:"meta",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"modified",id:"modified",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"modified_gmt",id:"modified_gmt",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"ping_status",id:"ping_status",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"slug",id:"slug",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"status",id:"status",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"sticky",id:"sticky",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"tags",id:"tags",level:3},{value:"Defined in",id:"defined-in-20",level:4},{value:"template",id:"template",level:3},{value:"Defined in",id:"defined-in-21",level:4},{value:"terms",id:"terms",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"type",id:"type",level:3},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-26",level:4}],o={toc:l};function c(e){let{components:t,...a}=e;return(0,i.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostEntity"),(0,i.kt)("p",null,"Interface for entities from the /wp/v2/posts endpoint."),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"PostTypeEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"PostEntity"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"_embedded"},"_","embedded"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"_","embedded"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"author")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wp:term")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]")))),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#_embedded"},"_embedded")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L98"},"packages/core/src/data/types/entities.ts:98")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"author"},"author"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"author"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#author"},"author")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L94"},"packages/core/src/data/types/entities.ts:94")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"categories"},"categories"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"categories"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,i.kt)("p",null,"The terms assigned to the object in the category taxonomy."),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L164"},"packages/core/src/data/types/entities.ts:164")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"comment_status"},"comment","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"comment","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not comments are open on the object."),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#comment_status"},"comment_status")),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L106"},"packages/core/src/data/types/entities.ts:106")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"content"},"content"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"content"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The content for the object."),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L124"},"packages/core/src/data/types/entities.ts:124")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date"},"date"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date"},"date")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L42"},"packages/core/src/data/types/entities.ts:42")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date_gmt"},"date","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, as GMT."),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date_gmt"},"date_gmt")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L47"},"packages/core/src/data/types/entities.ts:47")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"excerpt"},"excerpt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"excerpt"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The excerpt for the object."),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L129"},"packages/core/src/data/types/entities.ts:129")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"featured_media"},"featured","_","media"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"featured","_","media"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The ID of the featured media for the object."),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L174"},"packages/core/src/data/types/entities.ts:174")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"format"},"format"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"format"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"link"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"status"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"standard"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"aside"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"chat"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"gallery"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"image"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"quote"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"video"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"audio"')),(0,i.kt)("p",null,"The format for the object."),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L134"},"packages/core/src/data/types/entities.ts:134")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"guid"},"guid"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"guid"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The globally unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#guid"},"guid")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L52"},"packages/core/src/data/types/entities.ts:52")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"id"},"id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#id"},"id")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L67"},"packages/core/src/data/types/entities.ts:67")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"link"},"link"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"link"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"URL to the object."),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#link"},"link")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L72"},"packages/core/src/data/types/entities.ts:72")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"meta"},"meta"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"meta"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,i.kt)("p",null,"Meta fields."),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L149"},"packages/core/src/data/types/entities.ts:149")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified"},"modified"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified"},"modified")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L57"},"packages/core/src/data/types/entities.ts:57")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified_gmt"},"modified","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, as GMT."),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified_gmt"},"modified_gmt")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L62"},"packages/core/src/data/types/entities.ts:62")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ping_status"},"ping","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ping","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not the object can be pinged."),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#ping_status"},"ping_status")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L111"},"packages/core/src/data/types/entities.ts:111")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"slug"},"slug"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"slug"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"An alphanumeric identifier for the object unique to its type."),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#slug"},"slug")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L77"},"packages/core/src/data/types/entities.ts:77")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"status"},"status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"publish"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"future"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"draft"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"pending"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"private"')),(0,i.kt)("p",null,"A named status for the object."),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#status"},"status")),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L82"},"packages/core/src/data/types/entities.ts:82")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"sticky"},"sticky"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"sticky"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"boolean")),(0,i.kt)("p",null,"Whether or not the object should be treated as sticky."),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L154"},"packages/core/src/data/types/entities.ts:154")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"tags"},"tags"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"tags"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number"),"[]"),(0,i.kt)("p",null,"The terms assigned to the object in the post_tag taxonomy."),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L169"},"packages/core/src/data/types/entities.ts:169")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"template"},"template"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"template"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The theme file to use to display the object."),(0,i.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L159"},"packages/core/src/data/types/entities.ts:159")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"terms"},"terms"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"terms"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,i.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#terms"},"terms")),(0,i.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L96"},"packages/core/src/data/types/entities.ts:96")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The title for the object."),(0,i.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#title"},"title")),(0,i.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L92"},"packages/core/src/data/types/entities.ts:92")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"type"},"type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Type of Post for the object."),(0,i.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#type"},"type")),(0,i.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L87"},"packages/core/src/data/types/entities.ts:87")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head"},"yoast_head")),(0,i.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L114"},"packages/core/src/data/types/entities.ts:114")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head_json"},"yoast_head_json")),(0,i.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L113"},"packages/core/src/data/types/entities.ts:113")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5c59fa4a.ef0735d5.js b/assets/js/5c59fa4a.c336463c.js similarity index 95% rename from assets/js/5c59fa4a.ef0735d5.js rename to assets/js/5c59fa4a.c336463c.js index 24bdc4ed2..345831844 100644 --- a/assets/js/5c59fa4a.ef0735d5.js +++ b/assets/js/5c59fa4a.c336463c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4192],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>f});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),l=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},s=function(e){var t=l(e.components);return r.createElement(o.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),c=l(a),k=n,f=c["".concat(o,".").concat(k)]||c[k]||h[k]||i;return a?r.createElement(f,p(p({ref:t},s),{},{components:a})):r.createElement(f,p({ref:t},s))}));function f(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=k;var d={};for(var o in t)hasOwnProperty.call(t,o)&&(d[o]=t[o]);d.originalType=e,d[c]="string"==typeof e?e:n,p[1]=d;for(var l=2;l{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>d,toc:()=>l});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.PostSearchEntity",title:"Interface: PostSearchEntity",sidebar_label:"@headstartwp/core.PostSearchEntity",custom_edit_url:null},p=void 0,d={unversionedId:"interfaces/headstartwp_core.PostSearchEntity",id:"interfaces/headstartwp_core.PostSearchEntity",title:"Interface: PostSearchEntity",description:"@headstartwp/core.PostSearchEntity",source:"@site/docs/interfaces/headstartwp_core.PostSearchEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PostSearchEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostSearchEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostSearchEntity",title:"Interface: PostSearchEntity",sidebar_label:"@headstartwp/core.PostSearchEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PostParams",permalink:"/docs/api/interfaces/headstartwp_core.PostParams"},next:{title:"@headstartwp/core.PostTypeEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"}},o={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embedded",id:"_embedded",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"author",id:"author",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"subtype",id:"subtype",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"terms",id:"terms",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"type",id:"type",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"url",id:"url",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-9",level:4}],s={toc:l};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostSearchEntity"),(0,n.kt)("p",null,"Interface for posts entities from the /wp/v2/search endpoint."),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"SearchObjectEntity"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"PostSearchEntity"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"_embedded"},"_","embedded"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"_","embedded"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"author")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"self")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")),"[]")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"wp:term")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]")))),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L689"},"packages/core/src/data/types/entities.ts:689")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"author"},"author"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"author"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L685"},"packages/core/src/data/types/entities.ts:685")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"id"},"id"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"id"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"Unique identifier for the object."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},"SearchObjectEntity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity#id"},"id")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L658"},"packages/core/src/data/types/entities.ts:658")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"subtype"},"subtype"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"subtype"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Subtype of Search for the object."),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L683"},"packages/core/src/data/types/entities.ts:683")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"terms"},"terms"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"terms"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L687"},"packages/core/src/data/types/entities.ts:687")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"title"},"title"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"title"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The title for the object."),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},"SearchObjectEntity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity#title"},"title")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L668"},"packages/core/src/data/types/entities.ts:668")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"type"},"type"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"type"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"post"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"term"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"post-format"')),(0,n.kt)("p",null,"Type of Search for the object."),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},"SearchObjectEntity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity#type"},"type")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L673"},"packages/core/src/data/types/entities.ts:673")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"url"},"url"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"url"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"URL to the object."),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},"SearchObjectEntity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity#url"},"url")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L663"},"packages/core/src/data/types/entities.ts:663")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},"SearchObjectEntity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity#yoast_head"},"yoast_head")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},"SearchObjectEntity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity#yoast_head_json"},"yoast_head_json")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4192],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>f});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),l=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},s=function(e){var t=l(e.components);return r.createElement(o.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),c=l(a),k=n,f=c["".concat(o,".").concat(k)]||c[k]||h[k]||i;return a?r.createElement(f,p(p({ref:t},s),{},{components:a})):r.createElement(f,p({ref:t},s))}));function f(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=k;var d={};for(var o in t)hasOwnProperty.call(t,o)&&(d[o]=t[o]);d.originalType=e,d[c]="string"==typeof e?e:n,p[1]=d;for(var l=2;l{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>d,toc:()=>l});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.PostSearchEntity",title:"Interface: PostSearchEntity",sidebar_label:"@headstartwp/core.PostSearchEntity",custom_edit_url:null},p=void 0,d={unversionedId:"interfaces/headstartwp_core.PostSearchEntity",id:"interfaces/headstartwp_core.PostSearchEntity",title:"Interface: PostSearchEntity",description:"@headstartwp/core.PostSearchEntity",source:"@site/docs/interfaces/headstartwp_core.PostSearchEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PostSearchEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostSearchEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostSearchEntity",title:"Interface: PostSearchEntity",sidebar_label:"@headstartwp/core.PostSearchEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PostParams",permalink:"/docs/api/interfaces/headstartwp_core.PostParams"},next:{title:"@headstartwp/core.PostTypeEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"}},o={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embedded",id:"_embedded",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"author",id:"author",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"subtype",id:"subtype",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"terms",id:"terms",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"type",id:"type",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"url",id:"url",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-9",level:4}],s={toc:l};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostSearchEntity"),(0,n.kt)("p",null,"Interface for posts entities from the /wp/v2/search endpoint."),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"SearchObjectEntity"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"PostSearchEntity"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"_embedded"},"_","embedded"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"_","embedded"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"author")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"self")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")),"[]")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"wp:term")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]")))),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L689"},"packages/core/src/data/types/entities.ts:689")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"author"},"author"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"author"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L685"},"packages/core/src/data/types/entities.ts:685")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"id"},"id"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"id"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"Unique identifier for the object."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},"SearchObjectEntity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity#id"},"id")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L658"},"packages/core/src/data/types/entities.ts:658")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"subtype"},"subtype"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"subtype"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Subtype of Search for the object."),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L683"},"packages/core/src/data/types/entities.ts:683")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"terms"},"terms"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"terms"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L687"},"packages/core/src/data/types/entities.ts:687")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"title"},"title"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"title"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The title for the object."),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},"SearchObjectEntity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity#title"},"title")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L668"},"packages/core/src/data/types/entities.ts:668")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"type"},"type"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"type"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"post"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"term"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"post-format"')),(0,n.kt)("p",null,"Type of Search for the object."),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},"SearchObjectEntity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity#type"},"type")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L673"},"packages/core/src/data/types/entities.ts:673")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"url"},"url"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"url"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"URL to the object."),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},"SearchObjectEntity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity#url"},"url")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L663"},"packages/core/src/data/types/entities.ts:663")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},"SearchObjectEntity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity#yoast_head"},"yoast_head")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},"SearchObjectEntity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity#yoast_head_json"},"yoast_head_json")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5e4e234e.2562e48f.js b/assets/js/5e4e234e.2a4ef17a.js similarity index 94% rename from assets/js/5e4e234e.2562e48f.js rename to assets/js/5e4e234e.2a4ef17a.js index 1ea74acd8..2df8d2759 100644 --- a/assets/js/5e4e234e.2562e48f.js +++ b/assets/js/5e4e234e.2a4ef17a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8596],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>f});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var s=a.createContext({}),c=function(e){var t=a.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},l=function(e){var t=c(e.components);return a.createElement(s.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,s=e.parentName,l=p(e,["components","mdxType","originalType","parentName"]),d=c(r),h=n,f=d["".concat(s,".").concat(h)]||d[h]||u[h]||i;return r?a.createElement(f,o(o({ref:t},l),{},{components:r})):a.createElement(f,o({ref:t},l))}));function f(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=h;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[d]="string"==typeof e?e:n,o[1]=p;for(var c=2;c{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>p,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.FetchOptions",title:"Interface: FetchOptions",sidebar_label:"@headstartwp/core.FetchOptions",custom_edit_url:null},o=void 0,p={unversionedId:"interfaces/headstartwp_core.FetchOptions",id:"interfaces/headstartwp_core.FetchOptions",title:"Interface: FetchOptions",description:"@headstartwp/core.FetchOptions",source:"@site/docs/interfaces/headstartwp_core.FetchOptions.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.FetchOptions",permalink:"/docs/api/interfaces/headstartwp_core.FetchOptions",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.FetchOptions",title:"Interface: FetchOptions",sidebar_label:"@headstartwp/core.FetchOptions",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.Entity",permalink:"/docs/api/interfaces/headstartwp_core.Entity"},next:{title:"@headstartwp/core.FetchResponse",permalink:"/docs/api/interfaces/headstartwp_core.FetchResponse"}},s={},c=[{value:"Properties",id:"properties",level:2},{value:"alternativePreviewAuthorizationHeader",id:"alternativepreviewauthorizationheader",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"bearerToken",id:"bearertoken",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"burstCache",id:"burstcache",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"previewToken",id:"previewtoken",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"throwIfNotFound",id:"throwifnotfound",level:3},{value:"Defined in",id:"defined-in-4",level:4}],l={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".FetchOptions"),(0,n.kt)("p",null,"The options supported by the default fetcher method"),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"alternativepreviewauthorizationheader"},"alternativePreviewAuthorizationHeader"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"alternativePreviewAuthorizationHeader"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Flag to enable using the alternative authorization header."),(0,n.kt)("p",null,"This can be useful if you have separate authentication on your project."),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L80"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:80")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"bearertoken"},"bearerToken"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"bearerToken"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The authentication token to use for the request."),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L66"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"burstcache"},"burstCache"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"burstCache"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Whether to burst cache by appending a timestamp to the query"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L85"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:85")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"previewtoken"},"previewToken"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"previewToken"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The preview token to use for the request."),(0,n.kt)("p",null,"These are tokens issued by the HeadstartWP plugin and is used to authenticate previews"),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L73"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"throwifnotfound"},"throwIfNotFound"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"throwIfNotFound"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Whether to thrown an exception if data is not found."),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L61"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:61")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8596],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>f});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var s=a.createContext({}),c=function(e){var t=a.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},l=function(e){var t=c(e.components);return a.createElement(s.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,s=e.parentName,l=p(e,["components","mdxType","originalType","parentName"]),d=c(r),h=n,f=d["".concat(s,".").concat(h)]||d[h]||u[h]||i;return r?a.createElement(f,o(o({ref:t},l),{},{components:r})):a.createElement(f,o({ref:t},l))}));function f(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=h;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[d]="string"==typeof e?e:n,o[1]=p;for(var c=2;c{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>p,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.FetchOptions",title:"Interface: FetchOptions",sidebar_label:"@headstartwp/core.FetchOptions",custom_edit_url:null},o=void 0,p={unversionedId:"interfaces/headstartwp_core.FetchOptions",id:"interfaces/headstartwp_core.FetchOptions",title:"Interface: FetchOptions",description:"@headstartwp/core.FetchOptions",source:"@site/docs/interfaces/headstartwp_core.FetchOptions.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.FetchOptions",permalink:"/docs/api/interfaces/headstartwp_core.FetchOptions",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.FetchOptions",title:"Interface: FetchOptions",sidebar_label:"@headstartwp/core.FetchOptions",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.Entity",permalink:"/docs/api/interfaces/headstartwp_core.Entity"},next:{title:"@headstartwp/core.FetchResponse",permalink:"/docs/api/interfaces/headstartwp_core.FetchResponse"}},s={},c=[{value:"Properties",id:"properties",level:2},{value:"alternativePreviewAuthorizationHeader",id:"alternativepreviewauthorizationheader",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"bearerToken",id:"bearertoken",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"burstCache",id:"burstcache",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"previewToken",id:"previewtoken",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"throwIfNotFound",id:"throwifnotfound",level:3},{value:"Defined in",id:"defined-in-4",level:4}],l={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".FetchOptions"),(0,n.kt)("p",null,"The options supported by the default fetcher method"),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"alternativepreviewauthorizationheader"},"alternativePreviewAuthorizationHeader"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"alternativePreviewAuthorizationHeader"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Flag to enable using the alternative authorization header."),(0,n.kt)("p",null,"This can be useful if you have separate authentication on your project."),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L80"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:80")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"bearertoken"},"bearerToken"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"bearerToken"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The authentication token to use for the request."),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L66"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"burstcache"},"burstCache"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"burstCache"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Whether to burst cache by appending a timestamp to the query"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L85"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:85")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"previewtoken"},"previewToken"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"previewToken"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The preview token to use for the request."),(0,n.kt)("p",null,"These are tokens issued by the HeadstartWP plugin and is used to authenticate previews"),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L73"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"throwifnotfound"},"throwIfNotFound"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"throwIfNotFound"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Whether to thrown an exception if data is not found."),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L61"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:61")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5ea6ed43.10fb8aec.js b/assets/js/5ea6ed43.baf1ccf4.js similarity index 98% rename from assets/js/5ea6ed43.10fb8aec.js rename to assets/js/5ea6ed43.baf1ccf4.js index 4e0660fdc..05ff64e80 100644 --- a/assets/js/5ea6ed43.10fb8aec.js +++ b/assets/js/5ea6ed43.baf1ccf4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5787],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var s=a.createContext({}),p=function(e){var t=a.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},l=function(e){var t=p(e.components);return a.createElement(s.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},f=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,s=e.parentName,l=c(e,["components","mdxType","originalType","parentName"]),d=p(r),f=n,m=d["".concat(s,".").concat(f)]||d[f]||u[f]||o;return r?a.createElement(m,i(i({ref:t},l),{},{components:r})):a.createElement(m,i({ref:t},l))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,i=new Array(o);i[0]=f;var c={};for(var s in t)hasOwnProperty.call(t,s)&&(c[s]=t[s]);c.originalType=e,c[d]="string"==typeof e?e:n,i[1]=c;for(var p=2;p{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>p});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.YoastSEOIntegration",title:"Interface: YoastSEOIntegration",sidebar_label:"@headstartwp/core.YoastSEOIntegration",custom_edit_url:null},i=void 0,c={unversionedId:"interfaces/headstartwp_core.YoastSEOIntegration",id:"interfaces/headstartwp_core.YoastSEOIntegration",title:"Interface: YoastSEOIntegration",description:"@headstartwp/core.YoastSEOIntegration",source:"@site/docs/interfaces/headstartwp_core.YoastSEOIntegration.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.YoastSEOIntegration",permalink:"/docs/api/interfaces/headstartwp_core.YoastSEOIntegration",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.YoastSEOIntegration",title:"Interface: YoastSEOIntegration",sidebar_label:"@headstartwp/core.YoastSEOIntegration",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.VerifyTokenParams",permalink:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams"},next:{title:"@headstartwp/core.react.AudioBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps"}},s={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"enable",id:"enable",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4}],l={toc:p};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".YoastSEOIntegration"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Integration"},(0,n.kt)("inlineCode",{parentName:"a"},"Integration"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"YoastSEOIntegration"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"enable"},"enable"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"enable"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Integration"},"Integration"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Integration#enable"},"enable")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/types.ts#L46"},"packages/core/src/types.ts:46")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5787],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var s=a.createContext({}),p=function(e){var t=a.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},l=function(e){var t=p(e.components);return a.createElement(s.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},f=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,s=e.parentName,l=c(e,["components","mdxType","originalType","parentName"]),d=p(r),f=n,m=d["".concat(s,".").concat(f)]||d[f]||u[f]||o;return r?a.createElement(m,i(i({ref:t},l),{},{components:r})):a.createElement(m,i({ref:t},l))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,i=new Array(o);i[0]=f;var c={};for(var s in t)hasOwnProperty.call(t,s)&&(c[s]=t[s]);c.originalType=e,c[d]="string"==typeof e?e:n,i[1]=c;for(var p=2;p{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>p});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.YoastSEOIntegration",title:"Interface: YoastSEOIntegration",sidebar_label:"@headstartwp/core.YoastSEOIntegration",custom_edit_url:null},i=void 0,c={unversionedId:"interfaces/headstartwp_core.YoastSEOIntegration",id:"interfaces/headstartwp_core.YoastSEOIntegration",title:"Interface: YoastSEOIntegration",description:"@headstartwp/core.YoastSEOIntegration",source:"@site/docs/interfaces/headstartwp_core.YoastSEOIntegration.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.YoastSEOIntegration",permalink:"/docs/api/interfaces/headstartwp_core.YoastSEOIntegration",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.YoastSEOIntegration",title:"Interface: YoastSEOIntegration",sidebar_label:"@headstartwp/core.YoastSEOIntegration",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.VerifyTokenParams",permalink:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams"},next:{title:"@headstartwp/core.react.AudioBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps"}},s={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"enable",id:"enable",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4}],l={toc:p};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".YoastSEOIntegration"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Integration"},(0,n.kt)("inlineCode",{parentName:"a"},"Integration"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"YoastSEOIntegration"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"enable"},"enable"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"enable"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Integration"},"Integration"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Integration#enable"},"enable")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/types.ts#L46"},"packages/core/src/types.ts:46")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/5fc1d772.b08c5c58.js b/assets/js/5fc1d772.30121ee0.js similarity index 98% rename from assets/js/5fc1d772.b08c5c58.js rename to assets/js/5fc1d772.30121ee0.js index 6a9e01b20..2f712484f 100644 --- a/assets/js/5fc1d772.b08c5c58.js +++ b/assets/js/5fc1d772.30121ee0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5205],{3905:(t,e,a)=>{a.d(e,{Zo:()=>m,kt:()=>c});var n=a(7294);function r(t,e,a){return e in t?Object.defineProperty(t,e,{value:a,enumerable:!0,configurable:!0,writable:!0}):t[e]=a,t}function i(t,e){var a=Object.keys(t);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(t);e&&(n=n.filter((function(e){return Object.getOwnPropertyDescriptor(t,e).enumerable}))),a.push.apply(a,n)}return a}function l(t){for(var e=1;e=0||(r[a]=t[a]);return r}(t,e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(t);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(t,a)&&(r[a]=t[a])}return r}var d=n.createContext({}),o=function(t){var e=n.useContext(d),a=e;return t&&(a="function"==typeof t?t(e):l(l({},e),t)),a},m=function(t){var e=o(t.components);return n.createElement(d.Provider,{value:e},t.children)},k="mdxType",s={inlineCode:"code",wrapper:function(t){var e=t.children;return n.createElement(n.Fragment,{},e)}},N=n.forwardRef((function(t,e){var a=t.components,r=t.mdxType,i=t.originalType,d=t.parentName,m=p(t,["components","mdxType","originalType","parentName"]),k=o(a),N=r,c=k["".concat(d,".").concat(N)]||k[N]||s[N]||i;return a?n.createElement(c,l(l({ref:e},m),{},{components:a})):n.createElement(c,l({ref:e},m))}));function c(t,e){var a=arguments,r=e&&e.mdxType;if("string"==typeof t||r){var i=a.length,l=new Array(i);l[0]=N;var p={};for(var d in e)hasOwnProperty.call(e,d)&&(p[d]=e[d]);p.originalType=t,p[k]="string"==typeof t?t:r,l[1]=p;for(var o=2;o{a.r(e),a.d(e,{assets:()=>d,contentTitle:()=>l,default:()=>k,frontMatter:()=>i,metadata:()=>p,toc:()=>o});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.react.StylesProperties",title:"Interface: StylesProperties",sidebar_label:"@headstartwp/core.react.StylesProperties",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.react.StylesProperties",id:"interfaces/headstartwp_core.react.StylesProperties",title:"Interface: StylesProperties",description:"@headstartwp/core.react.StylesProperties",source:"@site/docs/interfaces/headstartwp_core.react.StylesProperties.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.StylesProperties",permalink:"/docs/api/interfaces/headstartwp_core.react.StylesProperties",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.StylesProperties",title:"Interface: StylesProperties",sidebar_label:"@headstartwp/core.react.StylesProperties",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.StylesElementsPropertiesComplete",permalink:"/docs/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete"},next:{title:"@headstartwp/core.react.TableBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps"}},d={},o=[{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"border",id:"border",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"color",id:"color",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"spacing",id:"spacing",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"typography",id:"typography",level:3},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Defined in",id:"defined-in-3",level:4}],m={toc:o};function k(t){let{components:e,...a}=t;return(0,r.kt)("wrapper",(0,n.Z)({},m,a,{components:e,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".StylesProperties"),(0,r.kt)("h2",{id:"indexable"},"Indexable"),(0,r.kt)("p",null,"\u25aa ","[k: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"border"},"border"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"border"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Border styles."),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"color?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"border-color")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"radius?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"border-radius")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"style?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"border-style")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"width?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"border-width")," CSS property.")))),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L555"},"packages/core/src/react/provider/types.ts:555")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"color"},"color"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"color"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Color styles."),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"background?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"background-color")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"gradient?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"background")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"text?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"color")," CSS property.")))),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L576"},"packages/core/src/react/provider/types.ts:576")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"spacing"},"spacing"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"spacing"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Spacing styles."),(0,r.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"blockGap?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"--wp--style--block-gap")," CSS custom property when settings.spacing.blockGap is true.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"bottom?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"left?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"right?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"top?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Margin styles.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.bottom?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"margin-bottom")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.left?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"margin-left")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.right?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"margin-right")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.top?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"margin-top")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"bottom?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"left?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"right?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"top?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Padding styles.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.bottom?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"padding-bottom")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.left?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"padding-left")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.right?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"padding-right")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.top?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"padding-top")," CSS property.")))),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L593"},"packages/core/src/react/provider/types.ts:593")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"typography"},"typography"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"typography"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Typography styles."),(0,r.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontFamily?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"font-family")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontSize?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"font-size")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontStyle?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"font-style")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontWeight?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"font-weight")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"letterSpacing?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"letter-spacing")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"lineHeight?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"line-height")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"textDecoration?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"text-decoration")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"textTransform?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"text-transform")," CSS property.")))),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L644"},"packages/core/src/react/provider/types.ts:644")))}k.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5205],{3905:(t,e,a)=>{a.d(e,{Zo:()=>m,kt:()=>c});var n=a(7294);function r(t,e,a){return e in t?Object.defineProperty(t,e,{value:a,enumerable:!0,configurable:!0,writable:!0}):t[e]=a,t}function i(t,e){var a=Object.keys(t);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(t);e&&(n=n.filter((function(e){return Object.getOwnPropertyDescriptor(t,e).enumerable}))),a.push.apply(a,n)}return a}function l(t){for(var e=1;e=0||(r[a]=t[a]);return r}(t,e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(t);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(t,a)&&(r[a]=t[a])}return r}var d=n.createContext({}),o=function(t){var e=n.useContext(d),a=e;return t&&(a="function"==typeof t?t(e):l(l({},e),t)),a},m=function(t){var e=o(t.components);return n.createElement(d.Provider,{value:e},t.children)},k="mdxType",s={inlineCode:"code",wrapper:function(t){var e=t.children;return n.createElement(n.Fragment,{},e)}},N=n.forwardRef((function(t,e){var a=t.components,r=t.mdxType,i=t.originalType,d=t.parentName,m=p(t,["components","mdxType","originalType","parentName"]),k=o(a),N=r,c=k["".concat(d,".").concat(N)]||k[N]||s[N]||i;return a?n.createElement(c,l(l({ref:e},m),{},{components:a})):n.createElement(c,l({ref:e},m))}));function c(t,e){var a=arguments,r=e&&e.mdxType;if("string"==typeof t||r){var i=a.length,l=new Array(i);l[0]=N;var p={};for(var d in e)hasOwnProperty.call(e,d)&&(p[d]=e[d]);p.originalType=t,p[k]="string"==typeof t?t:r,l[1]=p;for(var o=2;o{a.r(e),a.d(e,{assets:()=>d,contentTitle:()=>l,default:()=>k,frontMatter:()=>i,metadata:()=>p,toc:()=>o});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.react.StylesProperties",title:"Interface: StylesProperties",sidebar_label:"@headstartwp/core.react.StylesProperties",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.react.StylesProperties",id:"interfaces/headstartwp_core.react.StylesProperties",title:"Interface: StylesProperties",description:"@headstartwp/core.react.StylesProperties",source:"@site/docs/interfaces/headstartwp_core.react.StylesProperties.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.StylesProperties",permalink:"/docs/api/interfaces/headstartwp_core.react.StylesProperties",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.StylesProperties",title:"Interface: StylesProperties",sidebar_label:"@headstartwp/core.react.StylesProperties",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.StylesElementsPropertiesComplete",permalink:"/docs/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete"},next:{title:"@headstartwp/core.react.TableBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps"}},d={},o=[{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"border",id:"border",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"color",id:"color",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"spacing",id:"spacing",level:3},{value:"Type declaration",id:"type-declaration-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"typography",id:"typography",level:3},{value:"Type declaration",id:"type-declaration-3",level:4},{value:"Defined in",id:"defined-in-3",level:4}],m={toc:o};function k(t){let{components:e,...a}=t;return(0,r.kt)("wrapper",(0,n.Z)({},m,a,{components:e,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".StylesProperties"),(0,r.kt)("h2",{id:"indexable"},"Indexable"),(0,r.kt)("p",null,"\u25aa ","[k: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"border"},"border"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"border"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Border styles."),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"color?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"border-color")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"radius?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"border-radius")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"style?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"border-style")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"width?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"border-width")," CSS property.")))),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L555"},"packages/core/src/react/provider/types.ts:555")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"color"},"color"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"color"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Color styles."),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"background?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"background-color")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"gradient?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"background")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"text?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"color")," CSS property.")))),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L576"},"packages/core/src/react/provider/types.ts:576")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"spacing"},"spacing"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"spacing"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Spacing styles."),(0,r.kt)("h4",{id:"type-declaration-2"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"blockGap?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"--wp--style--block-gap")," CSS custom property when settings.spacing.blockGap is true.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"bottom?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"left?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"right?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"top?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Margin styles.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.bottom?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"margin-bottom")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.left?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"margin-left")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.right?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"margin-right")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"margin.top?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"margin-top")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding?")),(0,r.kt)("td",{parentName:"tr",align:"left"},"{ ",(0,r.kt)("inlineCode",{parentName:"td"},"bottom?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"left?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"right?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," ; ",(0,r.kt)("inlineCode",{parentName:"td"},"top?"),": ",(0,r.kt)("inlineCode",{parentName:"td"},"string")," }"),(0,r.kt)("td",{parentName:"tr",align:"left"},"Padding styles.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.bottom?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"padding-bottom")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.left?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"padding-left")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.right?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"padding-right")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"padding.top?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"padding-top")," CSS property.")))),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L593"},"packages/core/src/react/provider/types.ts:593")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"typography"},"typography"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"typography"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("p",null,"Typography styles."),(0,r.kt)("h4",{id:"type-declaration-3"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontFamily?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"font-family")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontSize?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"font-size")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontStyle?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"font-style")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"fontWeight?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"font-weight")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"letterSpacing?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"letter-spacing")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"lineHeight?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"line-height")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"textDecoration?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"text-decoration")," CSS property.")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"textTransform?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:"left"},"Sets the ",(0,r.kt)("inlineCode",{parentName:"td"},"text-transform")," CSS property.")))),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L644"},"packages/core/src/react/provider/types.ts:644")))}k.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/621a17a5.2f8b82d1.js b/assets/js/621a17a5.2f8b82d1.js new file mode 100644 index 000000000..df0e19136 --- /dev/null +++ b/assets/js/621a17a5.2f8b82d1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3629],{3905:(t,e,n)=>{n.d(e,{Zo:()=>c,kt:()=>h});var a=n(7294);function o(t,e,n){return e in t?Object.defineProperty(t,e,{value:n,enumerable:!0,configurable:!0,writable:!0}):t[e]=n,t}function r(t,e){var n=Object.keys(t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(t);e&&(a=a.filter((function(e){return Object.getOwnPropertyDescriptor(t,e).enumerable}))),n.push.apply(n,a)}return n}function i(t){for(var e=1;e=0||(o[n]=t[n]);return o}(t,e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(t);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(t,n)&&(o[n]=t[n])}return o}var s=a.createContext({}),u=function(t){var e=a.useContext(s),n=e;return t&&(n="function"==typeof t?t(e):i(i({},e),t)),n},c=function(t){var e=u(t.components);return a.createElement(s.Provider,{value:e},t.children)},p="mdxType",m={inlineCode:"code",wrapper:function(t){var e=t.children;return a.createElement(a.Fragment,{},e)}},d=a.forwardRef((function(t,e){var n=t.components,o=t.mdxType,r=t.originalType,s=t.parentName,c=l(t,["components","mdxType","originalType","parentName"]),p=u(n),d=o,h=p["".concat(s,".").concat(d)]||p[d]||m[d]||r;return n?a.createElement(h,i(i({ref:e},c),{},{components:n})):a.createElement(h,i({ref:e},c))}));function h(t,e){var n=arguments,o=e&&e.mdxType;if("string"==typeof t||o){var r=n.length,i=new Array(r);i[0]=d;var l={};for(var s in e)hasOwnProperty.call(e,s)&&(l[s]=e[s]);l.originalType=t,l[p]="string"==typeof t?t:o,i[1]=l;for(var u=2;u{n.r(e),n.d(e,{assets:()=>s,contentTitle:()=>i,default:()=>p,frontMatter:()=>r,metadata:()=>l,toc:()=>u});var a=n(7462),o=(n(7294),n(3905));const r={slug:"/data-fetching/mutating",sidebar_position:9},i="Mutating Data",l={unversionedId:"Data Fetching/mutating",id:"Data Fetching/mutating",title:"Mutating Data",description:'It is possible to use the useSwr mutate function to mutate data on the client. The data-fetching hooks expose the "bound mutate" function from swr. Below is an example of optimistically updating the UI to like a post.',source:"@site/documentation/02 - Data Fetching/mutating.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/mutating",permalink:"/docs/learn/data-fetching/mutating",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/mutating.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",sidebarPosition:9,frontMatter:{slug:"/data-fetching/mutating",sidebar_position:9},sidebar:"tutorialSidebar",previous:{title:"The useSeo hook",permalink:"/docs/learn/data-fetching/useSeo"},next:{title:"Creating your own custom hooks",permalink:"/docs/learn/data-fetching/creating-your-own-custom-hooks"}},s={},u=[],c={toc:u};function p(t){let{components:e,...n}=t;return(0,o.kt)("wrapper",(0,a.Z)({},c,n,{components:e,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"mutating-data"},"Mutating Data"),(0,o.kt)("p",null,"It is possible to use the ",(0,o.kt)("a",{parentName:"p",href:"https://swr.vercel.app/docs/mutation"},"useSwr mutate"),' function to mutate data on the client. The data-fetching hooks expose the "bound mutate" function from swr. Below is an example of optimistically updating the UI to like a post.'),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="Example of liking a post logic would look like"',title:'"Example',of:!0,liking:!0,a:!0,post:!0,logic:!0,would:!0,look:!0,'like"':!0},"const LikePost = () => {\n const { data, mutate } = usePost();\n\n if (loading) {\n return \n }\n\n function like() {\n if (!data) {\n return;\n }\n\n // run an async function `makeRequestToLikePost` \n // but update UI immediately with `optimisticData`\n // once the async function resolves, \n // it will revalidate the data from the server\n // this assumes the next request to fetch the same post will \n // return the updated count\n mutate(() => makeRequestToLikePost(data.post.id), {\n optimisticData: {\n ...data.post,\n meta: {\n ...data.post.meta,\n like_count: data.post.meta.like_count + 1\n }\n }\n });\n }\n return {like()}} />\n}\n")),(0,o.kt)("p",null,"In the example above we're assuming a post has a meta field called ",(0,o.kt)("inlineCode",{parentName:"p"},"like_count")," that holds the total number of likes the post has. When clicking the like button,\nit will issue a remote fetch call to run the mutation on the server but update the UI immediately with `optimisticData``."),(0,o.kt)("p",null,"Once the remote mutation finishes running, another request will be issued by the framework to re-fetch the post, which we assume, will already have the updated ",(0,o.kt)("inlineCode",{parentName:"p"},"like_count"),"."),(0,o.kt)("p",null,"If for some reason, anything fails with the remote mutation, when revalidating the data will roll back to the previous value."))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/637a3551.de9a820b.js b/assets/js/637a3551.d0e218e9.js similarity index 90% rename from assets/js/637a3551.de9a820b.js rename to assets/js/637a3551.d0e218e9.js index 7f9684667..a5b7b6a37 100644 --- a/assets/js/637a3551.de9a820b.js +++ b/assets/js/637a3551.d0e218e9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3200],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function p(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var o=a.createContext({}),c=function(e){var t=a.useContext(o),r=t;return e&&(r="function"==typeof e?e(t):p(p({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(o.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),s=c(r),m=n,h=s["".concat(o,".").concat(m)]||s[m]||k[m]||i;return r?a.createElement(h,p(p({ref:t},d),{},{components:r})):a.createElement(h,p({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,p=new Array(i);p[0]=m;var l={};for(var o in t)hasOwnProperty.call(t,o)&&(l[o]=t[o]);l.originalType=e,l[s]="string"==typeof e?e:n,p[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>p,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.VerseBlockProps",title:"Interface: VerseBlockProps",sidebar_label:"@headstartwp/core.react.VerseBlockProps",custom_edit_url:null},p=void 0,l={unversionedId:"interfaces/headstartwp_core.react.VerseBlockProps",id:"interfaces/headstartwp_core.react.VerseBlockProps",title:"Interface: VerseBlockProps",description:"@headstartwp/core.react.VerseBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.VerseBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.VerseBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.VerseBlockProps",title:"Interface: VerseBlockProps",sidebar_label:"@headstartwp/core.react.VerseBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.Typography",permalink:"/docs/api/interfaces/headstartwp_core.react.Typography"},next:{title:"@headstartwp/core.react.WpThemeJSON",permalink:"/docs/api/interfaces/headstartwp_core.react.WpThemeJSON"}},o={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".VerseBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"VerseBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3200],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function p(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var o=a.createContext({}),c=function(e){var t=a.useContext(o),r=t;return e&&(r="function"==typeof e?e(t):p(p({},t),e)),r},s=function(e){var t=c(e.components);return a.createElement(o.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),d=c(r),m=n,h=d["".concat(o,".").concat(m)]||d[m]||k[m]||i;return r?a.createElement(h,p(p({ref:t},s),{},{components:r})):a.createElement(h,p({ref:t},s))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,p=new Array(i);p[0]=m;var l={};for(var o in t)hasOwnProperty.call(t,o)&&(l[o]=t[o]);l.originalType=e,l[d]="string"==typeof e?e:n,p[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>p,default:()=>d,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.VerseBlockProps",title:"Interface: VerseBlockProps",sidebar_label:"@headstartwp/core.react.VerseBlockProps",custom_edit_url:null},p=void 0,l={unversionedId:"interfaces/headstartwp_core.react.VerseBlockProps",id:"interfaces/headstartwp_core.react.VerseBlockProps",title:"Interface: VerseBlockProps",description:"@headstartwp/core.react.VerseBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.VerseBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.VerseBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.VerseBlockProps",title:"Interface: VerseBlockProps",sidebar_label:"@headstartwp/core.react.VerseBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.Typography",permalink:"/docs/api/interfaces/headstartwp_core.react.Typography"},next:{title:"@headstartwp/core.react.WpThemeJSON",permalink:"/docs/api/interfaces/headstartwp_core.react.WpThemeJSON"}},o={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],s={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".VerseBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"VerseBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/66ab7d90.95ca657b.js b/assets/js/66ab7d90.1843ed90.js similarity index 96% rename from assets/js/66ab7d90.95ca657b.js rename to assets/js/66ab7d90.1843ed90.js index 407a828fc..946e7aa7f 100644 --- a/assets/js/66ab7d90.95ca657b.js +++ b/assets/js/66ab7d90.1843ed90.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[520],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>u});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function s(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),l=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=l(e.components);return r.createElement(p.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,s=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),c=l(a),m=n,u=c["".concat(p,".").concat(m)]||c[m]||h[m]||s;return a?r.createElement(u,i(i({ref:t},d),{},{components:a})):r.createElement(u,i({ref:t},d))}));function u(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var s=a.length,i=new Array(s);i[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[c]="string"==typeof e?e:n,i[1]=o;for(var l=2;l{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>c,frontMatter:()=>s,metadata:()=>o,toc:()=>l});var r=a(7462),n=(a(7294),a(3905));const s={id:"headstartwp_core.PostOrPostsParams",title:"Interface: PostOrPostsParams",sidebar_label:"@headstartwp/core.PostOrPostsParams",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.PostOrPostsParams",id:"interfaces/headstartwp_core.PostOrPostsParams",title:"Interface: PostOrPostsParams",description:"@headstartwp/core.PostOrPostsParams",source:"@site/docs/interfaces/headstartwp_core.PostOrPostsParams.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PostOrPostsParams",permalink:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostOrPostsParams",title:"Interface: PostOrPostsParams",sidebar_label:"@headstartwp/core.PostOrPostsParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PostEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostEntity"},next:{title:"@headstartwp/core.PostParams",permalink:"/docs/api/interfaces/headstartwp_core.PostParams"}},p={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embed",id:"_embed",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"_fields",id:"_fields",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"archive",id:"archive",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"lang",id:"lang",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"priority",id:"priority",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"routeMatchStrategy",id:"routematchstrategy",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"single",id:"single",level:3},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:l};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostOrPostsParams"),(0,n.kt)("p",null,"The params supported by ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy"},"PostOrPostsFetchStrategy")),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"PostOrPostsParams"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"_embed"},"_","embed"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","embed"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"The _embed param returned associated entities in the response"),(0,n.kt)("p",null,"It's recommended to avoid additional requests to fetch data"),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_embed"},"_embed")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L17"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:17")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"_fields"},"_","fields"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","fields"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The _fields parameter is used to return only the specified fields in the response"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_fields"},"_fields")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L22"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:22")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"archive"},"archive"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"archive"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")),">"),(0,n.kt)("p",null,"The ",(0,n.kt)("inlineCode",{parentName:"p"},"archive")," params corresponds to ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},"PostsArchiveParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L25"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:25")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"lang"},"lang"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"lang"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The polylang ?lang parameter."),(0,n.kt)("p",null,"This is only used if the polylang integration is enabled"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#lang"},"lang")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L29"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:29")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"priority"},"priority"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"priority"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"archive"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"single"')),(0,n.kt)("p",null,"The priority indicates which strategy should execute first."),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L30"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:30")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"routematchstrategy"},"routeMatchStrategy"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"routeMatchStrategy"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"none"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"archive"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"single"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"both"')),(0,n.kt)("p",null,"How to handle route matching strategy, the possible values are:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"single")," will only trigger the single strategy if there's a url match for the single strategy"),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"archive")," will only trigger the archive strategy if there's a url match for the archive strategy"),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"both")," requires a route match for both single and archive")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L39"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:39")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"single"},"single"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"single"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams")),">"),(0,n.kt)("p",null,"The ",(0,n.kt)("inlineCode",{parentName:"p"},"single")," params corresponds to ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostParams"},"PostParams")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L20"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:20")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[520],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>u});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function s(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),l=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=l(e.components);return r.createElement(p.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,s=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),c=l(a),m=n,u=c["".concat(p,".").concat(m)]||c[m]||h[m]||s;return a?r.createElement(u,i(i({ref:t},d),{},{components:a})):r.createElement(u,i({ref:t},d))}));function u(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var s=a.length,i=new Array(s);i[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[c]="string"==typeof e?e:n,i[1]=o;for(var l=2;l{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>c,frontMatter:()=>s,metadata:()=>o,toc:()=>l});var r=a(7462),n=(a(7294),a(3905));const s={id:"headstartwp_core.PostOrPostsParams",title:"Interface: PostOrPostsParams",sidebar_label:"@headstartwp/core.PostOrPostsParams",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.PostOrPostsParams",id:"interfaces/headstartwp_core.PostOrPostsParams",title:"Interface: PostOrPostsParams",description:"@headstartwp/core.PostOrPostsParams",source:"@site/docs/interfaces/headstartwp_core.PostOrPostsParams.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PostOrPostsParams",permalink:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostOrPostsParams",title:"Interface: PostOrPostsParams",sidebar_label:"@headstartwp/core.PostOrPostsParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PostEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostEntity"},next:{title:"@headstartwp/core.PostParams",permalink:"/docs/api/interfaces/headstartwp_core.PostParams"}},p={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embed",id:"_embed",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"_fields",id:"_fields",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"archive",id:"archive",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"lang",id:"lang",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"priority",id:"priority",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"routeMatchStrategy",id:"routematchstrategy",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"single",id:"single",level:3},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:l};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostOrPostsParams"),(0,n.kt)("p",null,"The params supported by ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy"},"PostOrPostsFetchStrategy")),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"PostOrPostsParams"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"_embed"},"_","embed"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","embed"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"The _embed param returned associated entities in the response"),(0,n.kt)("p",null,"It's recommended to avoid additional requests to fetch data"),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_embed"},"_embed")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L17"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:17")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"_fields"},"_","fields"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","fields"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The _fields parameter is used to return only the specified fields in the response"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_fields"},"_fields")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L22"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:22")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"archive"},"archive"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"archive"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")),">"),(0,n.kt)("p",null,"The ",(0,n.kt)("inlineCode",{parentName:"p"},"archive")," params corresponds to ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},"PostsArchiveParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L25"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:25")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"lang"},"lang"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"lang"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The polylang ?lang parameter."),(0,n.kt)("p",null,"This is only used if the polylang integration is enabled"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#lang"},"lang")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L29"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:29")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"priority"},"priority"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"priority"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"archive"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"single"')),(0,n.kt)("p",null,"The priority indicates which strategy should execute first."),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L30"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:30")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"routematchstrategy"},"routeMatchStrategy"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"routeMatchStrategy"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"none"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"archive"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"single"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"both"')),(0,n.kt)("p",null,"How to handle route matching strategy, the possible values are:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"single")," will only trigger the single strategy if there's a url match for the single strategy"),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"archive")," will only trigger the archive strategy if there's a url match for the archive strategy"),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"both")," requires a route match for both single and archive")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L39"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:39")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"single"},"single"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"single"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams")),">"),(0,n.kt)("p",null,"The ",(0,n.kt)("inlineCode",{parentName:"p"},"single")," params corresponds to ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostParams"},"PostParams")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L20"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:20")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/66decef0.598fbc31.js b/assets/js/66decef0.7f0a5bf4.js similarity index 97% rename from assets/js/66decef0.598fbc31.js rename to assets/js/66decef0.7f0a5bf4.js index 08f4c2469..2a5264a56 100644 --- a/assets/js/66decef0.598fbc31.js +++ b/assets/js/66decef0.7f0a5bf4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1932],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||o;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,l=new Array(o);l[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:n,l[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.IQuoteBlock",title:"Interface: IQuoteBlock",sidebar_label:"@headstartwp/core.react.IQuoteBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IQuoteBlock",id:"interfaces/headstartwp_core.react.IQuoteBlock",title:"Interface: IQuoteBlock",description:"@headstartwp/core.react.IQuoteBlock",source:"@site/docs/interfaces/headstartwp_core.react.IQuoteBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IQuoteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IQuoteBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IQuoteBlock",title:"Interface: IQuoteBlock",sidebar_label:"@headstartwp/core.react.IQuoteBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IPullQuoteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IPullQuoteBlock"},next:{title:"@headstartwp/core.react.ISeparatorBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ISeparatorBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IQuoteBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"QuoteBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IQuoteBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"QuoteBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"QuoteBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1932],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||o;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,l=new Array(o);l[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:n,l[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.IQuoteBlock",title:"Interface: IQuoteBlock",sidebar_label:"@headstartwp/core.react.IQuoteBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IQuoteBlock",id:"interfaces/headstartwp_core.react.IQuoteBlock",title:"Interface: IQuoteBlock",description:"@headstartwp/core.react.IQuoteBlock",source:"@site/docs/interfaces/headstartwp_core.react.IQuoteBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IQuoteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IQuoteBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IQuoteBlock",title:"Interface: IQuoteBlock",sidebar_label:"@headstartwp/core.react.IQuoteBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IPullQuoteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IPullQuoteBlock"},next:{title:"@headstartwp/core.react.ISeparatorBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ISeparatorBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IQuoteBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"QuoteBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IQuoteBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"QuoteBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"QuoteBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/670e912d.79bee858.js b/assets/js/670e912d.5cff9589.js similarity index 96% rename from assets/js/670e912d.79bee858.js rename to assets/js/670e912d.5cff9589.js index 38ed6b326..2d4d40c2b 100644 --- a/assets/js/670e912d.79bee858.js +++ b/assets/js/670e912d.5cff9589.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1497],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function c(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var u=n.createContext({}),l=function(e){var t=n.useContext(u),r=t;return e&&(r="function"==typeof e?e(t):c(c({},t),e)),r},d=function(e){var t=l(e.components);return n.createElement(u.Provider,{value:t},e.children)},s="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,u=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=l(r),f=a,m=s["".concat(u,".").concat(f)]||s[f]||p[f]||o;return r?n.createElement(m,c(c({ref:t},d),{},{components:r})):n.createElement(m,c({ref:t},d))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,c=new Array(o);c[0]=f;var i={};for(var u in t)hasOwnProperty.call(t,u)&&(i[u]=t[u]);i.originalType=e,i[s]="string"==typeof e?e:a,c[1]=i;for(var l=2;l{r.r(t),r.d(t,{assets:()=>u,contentTitle:()=>c,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var n=r(7462),a=(r(7294),r(3905));const o={},c="Implementing a Youtube Facade",i={unversionedId:"Guides/youtube-facade",id:"Guides/youtube-facade",title:"Implementing a Youtube Facade",description:"HeadstartWP provides an easy way to implement Youtube Facade, in fact, we can do so with one line of code. All that\u2019s needed is to add the YoutubeLiteBlock component",source:"@site/documentation/08-Guides/youtube-facade.md",sourceDirName:"08-Guides",slug:"/Guides/youtube-facade",permalink:"/docs/learn/Guides/youtube-facade",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/08-Guides/youtube-facade.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"TypeScript",permalink:"/docs/learn/Guides/typescript"}},u={},l=[],d={toc:l};function s(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"implementing-a-youtube-facade"},"Implementing a Youtube Facade"),(0,a.kt)("p",null,"HeadstartWP provides an easy way to implement Youtube Facade, in fact, we can do so with one line of code. All that\u2019s needed is to add the YoutubeLiteBlock component"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"import { BlocksRenderer, YoutubeLiteBlock } from '@headstartwp/core/react';\n\n\n {/*... */}\n \n\n")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1497],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function c(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var u=n.createContext({}),l=function(e){var t=n.useContext(u),r=t;return e&&(r="function"==typeof e?e(t):c(c({},t),e)),r},d=function(e){var t=l(e.components);return n.createElement(u.Provider,{value:t},e.children)},s="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,u=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=l(r),f=a,m=s["".concat(u,".").concat(f)]||s[f]||p[f]||o;return r?n.createElement(m,c(c({ref:t},d),{},{components:r})):n.createElement(m,c({ref:t},d))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,c=new Array(o);c[0]=f;var i={};for(var u in t)hasOwnProperty.call(t,u)&&(i[u]=t[u]);i.originalType=e,i[s]="string"==typeof e?e:a,c[1]=i;for(var l=2;l{r.r(t),r.d(t,{assets:()=>u,contentTitle:()=>c,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var n=r(7462),a=(r(7294),r(3905));const o={},c="Implementing a Youtube Facade",i={unversionedId:"Guides/youtube-facade",id:"Guides/youtube-facade",title:"Implementing a Youtube Facade",description:"HeadstartWP provides an easy way to implement Youtube Facade, in fact, we can do so with one line of code. All that\u2019s needed is to add the YoutubeLiteBlock component",source:"@site/documentation/08-Guides/youtube-facade.md",sourceDirName:"08-Guides",slug:"/Guides/youtube-facade",permalink:"/docs/learn/Guides/youtube-facade",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/08-Guides/youtube-facade.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"TypeScript",permalink:"/docs/learn/Guides/typescript"}},u={},l=[],d={toc:l};function s(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"implementing-a-youtube-facade"},"Implementing a Youtube Facade"),(0,a.kt)("p",null,"HeadstartWP provides an easy way to implement Youtube Facade, in fact, we can do so with one line of code. All that\u2019s needed is to add the YoutubeLiteBlock component"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js"},"import { BlocksRenderer, YoutubeLiteBlock } from '@headstartwp/core/react';\n\n\n {/*... */}\n \n\n")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6e304a43.4c37d926.js b/assets/js/6e304a43.49ec04cc.js similarity index 97% rename from assets/js/6e304a43.4c37d926.js rename to assets/js/6e304a43.49ec04cc.js index a406baad9..195f16867 100644 --- a/assets/js/6e304a43.4c37d926.js +++ b/assets/js/6e304a43.49ec04cc.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2069],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||l;return a?r.createElement(h,i(i({ref:t},d),{},{components:a})):r.createElement(h,i({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,i=new Array(l);i[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.ISpacerBlock",title:"Interface: ISpacerBlock",sidebar_label:"@headstartwp/core.react.ISpacerBlock",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.ISpacerBlock",id:"interfaces/headstartwp_core.react.ISpacerBlock",title:"Interface: ISpacerBlock",description:"@headstartwp/core.react.ISpacerBlock",source:"@site/docs/interfaces/headstartwp_core.react.ISpacerBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ISpacerBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ISpacerBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ISpacerBlock",title:"Interface: ISpacerBlock",sidebar_label:"@headstartwp/core.react.ISpacerBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ISeparatorBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ISeparatorBlock"},next:{title:"@headstartwp/core.react.ITableBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ITableBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ISpacerBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SpacerBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ISpacerBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SpacerBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SpacerBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2069],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||l;return a?r.createElement(h,i(i({ref:t},d),{},{components:a})):r.createElement(h,i({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,i=new Array(l);i[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.ISpacerBlock",title:"Interface: ISpacerBlock",sidebar_label:"@headstartwp/core.react.ISpacerBlock",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.ISpacerBlock",id:"interfaces/headstartwp_core.react.ISpacerBlock",title:"Interface: ISpacerBlock",description:"@headstartwp/core.react.ISpacerBlock",source:"@site/docs/interfaces/headstartwp_core.react.ISpacerBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ISpacerBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ISpacerBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ISpacerBlock",title:"Interface: ISpacerBlock",sidebar_label:"@headstartwp/core.react.ISpacerBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ISeparatorBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ISeparatorBlock"},next:{title:"@headstartwp/core.react.ITableBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ITableBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ISpacerBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SpacerBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ISpacerBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SpacerBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SpacerBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6e83ed71.499e40e2.js b/assets/js/6e83ed71.be4c508d.js similarity index 89% rename from assets/js/6e83ed71.499e40e2.js rename to assets/js/6e83ed71.be4c508d.js index 64908d235..6ec869d02 100644 --- a/assets/js/6e83ed71.499e40e2.js +++ b/assets/js/6e83ed71.be4c508d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1513],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var l=n.createContext({}),o=function(e){var t=n.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},s=function(e){var t=o(e.components);return n.createElement(l.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,l=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),c=o(a),k=r,h=c["".concat(l,".").concat(k)]||c[k]||m[k]||i;return a?n.createElement(h,p(p({ref:t},s),{},{components:a})):n.createElement(h,p({ref:t},s))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,p=new Array(i);p[0]=k;var d={};for(var l in t)hasOwnProperty.call(t,l)&&(d[l]=t[l]);d.originalType=e,d[c]="string"==typeof e?e:r,p[1]=d;for(var o=2;o{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>d,toc:()=>o});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.AppEntity",title:"Interface: AppEntity",sidebar_label:"@headstartwp/core.AppEntity",custom_edit_url:null},p=void 0,d={unversionedId:"interfaces/headstartwp_core.AppEntity",id:"interfaces/headstartwp_core.AppEntity",title:"Interface: AppEntity",description:"@headstartwp/core.AppEntity",source:"@site/docs/interfaces/headstartwp_core.AppEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.AppEntity",permalink:"/docs/api/interfaces/headstartwp_core.AppEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.AppEntity",title:"Interface: AppEntity",sidebar_label:"@headstartwp/core.AppEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.VerifyTokenFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy"},next:{title:"@headstartwp/core.AttachmentEntity",permalink:"/docs/api/interfaces/headstartwp_core.AttachmentEntity"}},l={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"home",id:"home",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"menus",id:"menus",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"settings",id:"settings",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"theme.json",id:"themejson",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-5",level:4}],s={toc:o};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".AppEntity"),(0,r.kt)("p",null,"Empty interface from which all entities inherit."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,r.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"AppEntity"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"home"},"home"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"home"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L739"},"packages/core/src/data/types/entities.ts:739")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"menus"},"menus"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"menus"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"index-signature"},"Index signature"),(0,r.kt)("p",null,"\u25aa ","[k: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"MenuItemEntity")),"[]"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L736"},"packages/core/src/data/types/entities.ts:736")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settings"},"settings"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"settings"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"posts_per_page")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"privacy_policy_url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site_desc")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site_name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site_rss_url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site_wp_url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L743"},"packages/core/src/data/types/entities.ts:743")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"themejson"},"theme.json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"theme.json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L751"},"packages/core/src/data/types/entities.ts:751")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1513],{3905:(e,t,a)=>{a.d(t,{Zo:()=>s,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var d=n.createContext({}),o=function(e){var t=n.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},s=function(e){var t=o(e.components);return n.createElement(d.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,d=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),c=o(a),k=r,h=c["".concat(d,".").concat(k)]||c[k]||m[k]||i;return a?n.createElement(h,p(p({ref:t},s),{},{components:a})):n.createElement(h,p({ref:t},s))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,p=new Array(i);p[0]=k;var l={};for(var d in t)hasOwnProperty.call(t,d)&&(l[d]=t[d]);l.originalType=e,l[c]="string"==typeof e?e:r,p[1]=l;for(var o=2;o{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>o});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.AppEntity",title:"Interface: AppEntity",sidebar_label:"@headstartwp/core.AppEntity",custom_edit_url:null},p=void 0,l={unversionedId:"interfaces/headstartwp_core.AppEntity",id:"interfaces/headstartwp_core.AppEntity",title:"Interface: AppEntity",description:"@headstartwp/core.AppEntity",source:"@site/docs/interfaces/headstartwp_core.AppEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.AppEntity",permalink:"/docs/api/interfaces/headstartwp_core.AppEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.AppEntity",title:"Interface: AppEntity",sidebar_label:"@headstartwp/core.AppEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.VerifyTokenFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy"},next:{title:"@headstartwp/core.AttachmentEntity",permalink:"/docs/api/interfaces/headstartwp_core.AttachmentEntity"}},d={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"home",id:"home",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"menus",id:"menus",level:3},{value:"Index signature",id:"index-signature",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"settings",id:"settings",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"theme.json",id:"themejson",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-5",level:4}],s={toc:o};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},s,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".AppEntity"),(0,r.kt)("p",null,"Empty interface from which all entities inherit."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,r.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"AppEntity"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"home"},"home"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"home"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"id?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"number"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"slug?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L739"},"packages/core/src/data/types/entities.ts:739")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"menus"},"menus"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"menus"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"index-signature"},"Index signature"),(0,r.kt)("p",null,"\u25aa ","[k: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"MenuItemEntity")),"[]"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L736"},"packages/core/src/data/types/entities.ts:736")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"settings"},"settings"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"settings"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Object")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"posts_per_page")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"privacy_policy_url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site_desc")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site_name")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site_rss_url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site_wp_url")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"string"))))),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L743"},"packages/core/src/data/types/entities.ts:743")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"themejson"},"theme.json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"theme.json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L751"},"packages/core/src/data/types/entities.ts:751")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6e8d7793.7f060146.js b/assets/js/6e8d7793.4dd5df77.js similarity index 98% rename from assets/js/6e8d7793.7f060146.js rename to assets/js/6e8d7793.4dd5df77.js index 8315a29c9..3a09d229a 100644 --- a/assets/js/6e8d7793.7f060146.js +++ b/assets/js/6e8d7793.4dd5df77.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7272],{3905:(e,t,n)=>{n.d(t,{Zo:()=>h,kt:()=>m});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var l=a.createContext({}),p=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},h=function(e){var t=p(e.components);return a.createElement(l.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,l=e.parentName,h=i(e,["components","mdxType","originalType","parentName"]),c=p(n),d=r,m=c["".concat(l,".").concat(d)]||c[d]||u[d]||o;return n?a.createElement(m,s(s({ref:t},h),{},{components:n})):a.createElement(m,s({ref:t},h))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,s=new Array(o);s[0]=d;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[c]="string"==typeof e?e:r,s[1]=i;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>c,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var a=n(7462),r=(n(7294),n(3905));const o={slug:"/data-fetching/use-post-or-posts",sidebar_position:4},s="The usePostOrPosts hook",i={unversionedId:"Data Fetching/usePostOrPosts",id:"Data Fetching/usePostOrPosts",title:"The usePostOrPosts hook",description:"This hook was introduced in @headstartwp/core@1.1.0 and @headstartwp/next@1.1.0",source:"@site/documentation/02 - Data Fetching/usePostOrPosts.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/use-post-or-posts",permalink:"/docs/learn/data-fetching/use-post-or-posts",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/usePostOrPosts.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",sidebarPosition:4,frontMatter:{slug:"/data-fetching/use-post-or-posts",sidebar_position:4},sidebar:"tutorialSidebar",previous:{title:"The useAuthorArchive Hook",permalink:"/docs/learn/data-fetching/useauthorarchive"},next:{title:"The useTerms hook",permalink:"/docs/learn/data-fetching/useterms"}},l={},p=[{value:"Basic Usage",id:"basic-usage",level:2},{value:"Return values",id:"return-values",level:3},{value:"single and archive params",id:"single-and-archive-params",level:3},{value:"priority",id:"priority",level:3},{value:"routeMatchStrategy",id:"routematchstrategy",level:3}],h={toc:p};function c(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},h,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"the-usepostorposts-hook"},"The usePostOrPosts hook"),(0,r.kt)("admonition",{type:"info"},(0,r.kt)("p",{parentName:"admonition"},"This hook was introduced in ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/core@1.1.0")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/next@1.1.0"))),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},"The ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next#usepostorposts"},"usePostOrPosts")," hook is the Next.js binding for the ",(0,r.kt)("a",{parentName:"p",href:"/api/namespaces/headstartwp_core.react#usefetchpostorposts"},"useFetchPostOrPosts"),".")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePostOrPosts")," fetch either a single post or a collection of posts based on the current path. It is useful when you want to prefix the archive and the single posts with the same prefix. E.g: /blog/post-name and /blog/news"),(0,r.kt)("h2",{id:"basic-usage"},"Basic Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},"// src/pages/blog/[...path].js\n\nconst blogParams = {\n single: {\n postType: 'post',\n },\n archive: {\n postType: 'post',\n taxonomy: 'category',\n },\n priority: 'single',\n routeMatchStrategy: 'single',\n};\n\nconst Archive = () => {\n const { data } = usePosts(blogParams.archive);\n\n return (\n <>\n

Blog Page

\n
    \n {data.posts.map((post) => (\n
  • \n {post.title.rendered}\n
    • \n ))}\n
\n \n );\n};\n\nconst PageContent = ({ params }) => {\n const { data } = usePost(params);\n\n return (\n <>\n

\n \n

\n \n \n );\n};\n\n\nconst BlogPage = () => {\n const { isArchive } = usePostOrPosts(blogParams);\n\n if (isArchive) {\n return ;\n }\n\n return ;\n};\n\nexport async function getServerSideProps(context) {\n try {\n const settledPromises = await resolveBatch([\n {\n func: fetchHookData(usePostOrPosts.fetcher(), context, { params: blogParams }),\n },\n ]);\n\n return addHookData(settledPromises, {});\n } catch (e) {\n return handleError(e, context);\n }\n}\n")),(0,r.kt)("p",null,"The above route will match the following URLs:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"/blog/","[category]"),(0,r.kt)("li",{parentName:"ul"},"/blog/","[category]","/page/","[page]"),(0,r.kt)("li",{parentName:"ul"},"/blog/","[category]","/","[post-name]"," (this route will only work if the ",(0,r.kt)("inlineCode",{parentName:"li"},"post.link")," property matches this structure in WP)"),(0,r.kt)("li",{parentName:"ul"},"/blog/","[post-name]"," (this route will only work if the ",(0,r.kt)("inlineCode",{parentName:"li"},"post.link")," property matches this structure in WP)")),(0,r.kt)("h3",{id:"return-values"},"Return values"),(0,r.kt)("p",null,"This hook returns the following things:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"isArchive"),": true if the resulting data is for an archive"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"isSingle"),": true if the resulting data is for a single post"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"post"),": if isSingle is true, will hold the data for a single post"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"posts"),": if isArchive is true, will hold the data for an archive")),(0,r.kt)("p",null,"When using the ",(0,r.kt)("inlineCode",{parentName:"p"},"usePostOrPosts")," hook you can also use ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," without needing to make additional fetch calls. The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePostOrPosts")," hook will populate the cache for ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts"),". That is why in the example on the page, the actual data is pulled from ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts"),"."),(0,r.kt)("h3",{id:"single-and-archive-params"},"single and archive params"),(0,r.kt)("p",null,"The route above is going to try to fetch either a single post or a post archive based on the current URL. The parameters passed to ",(0,r.kt)("inlineCode",{parentName:"p"},"single")," are the ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," parameters and the ",(0,r.kt)("inlineCode",{parentName:"p"},"archive")," params are the ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," params."),(0,r.kt)("h3",{id:"priority"},"priority"),(0,r.kt)("p",null,"The possible values for ",(0,r.kt)("inlineCode",{parentName:"p"},"priority")," are ",(0,r.kt)("inlineCode",{parentName:"p"},"single")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"archive"),". This setting exists to prioritize one strategy over the other when there are URL collisions. In the example on this page, there could be a slug collision where a post exists with the slug of a category. In that case, the ",(0,r.kt)("inlineCode",{parentName:"p"},"priority")," setting will dictate which one is going to be used."),(0,r.kt)("h3",{id:"routematchstrategy"},"routeMatchStrategy"),(0,r.kt)("p",null,"This setting controls whether ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js")," should match the fetch strategy. The possible values are ",(0,r.kt)("inlineCode",{parentName:"p"},"none")," (default), ",(0,r.kt)("inlineCode",{parentName:"p"},"single"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"archive")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"both"),"."),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"single"),": Will only fetch a single post if ",(0,r.kt)("inlineCode",{parentName:"li"},"[...path].js")," matches the structure of a single."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"archive"),": Will only fetch an archive if ",(0,r.kt)("inlineCode",{parentName:"li"},"[...path].js")," matches the structure of an archive."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"both"),": Will only fetch a single and an archive if they both match the expected url structure."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"none"),": Does not perform any checks against ",(0,r.kt)("inlineCode",{parentName:"li"},"[...path].js"),".")),(0,r.kt)("p",null,"As an example, if you are trying to have ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog")," fetch the latest posts and ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog/post-name")," fetch a single post and set ",(0,r.kt)("inlineCode",{parentName:"p"},"routeMatchStrategy")," to ",(0,r.kt)("inlineCode",{parentName:"p"},"archive"),", the ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog")," route will never work."))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7272],{3905:(e,t,n)=>{n.d(t,{Zo:()=>h,kt:()=>m});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var l=a.createContext({}),p=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},h=function(e){var t=p(e.components);return a.createElement(l.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,l=e.parentName,h=i(e,["components","mdxType","originalType","parentName"]),c=p(n),d=r,m=c["".concat(l,".").concat(d)]||c[d]||u[d]||o;return n?a.createElement(m,s(s({ref:t},h),{},{components:n})):a.createElement(m,s({ref:t},h))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,s=new Array(o);s[0]=d;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[c]="string"==typeof e?e:r,s[1]=i;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>c,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var a=n(7462),r=(n(7294),n(3905));const o={slug:"/data-fetching/use-post-or-posts",sidebar_position:4},s="The usePostOrPosts hook",i={unversionedId:"Data Fetching/usePostOrPosts",id:"Data Fetching/usePostOrPosts",title:"The usePostOrPosts hook",description:"This hook was introduced in @headstartwp/core@1.1.0 and @headstartwp/next@1.1.0",source:"@site/documentation/02 - Data Fetching/usePostOrPosts.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/use-post-or-posts",permalink:"/docs/learn/data-fetching/use-post-or-posts",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/usePostOrPosts.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",sidebarPosition:4,frontMatter:{slug:"/data-fetching/use-post-or-posts",sidebar_position:4},sidebar:"tutorialSidebar",previous:{title:"The useAuthorArchive Hook",permalink:"/docs/learn/data-fetching/useauthorarchive"},next:{title:"The useTerms hook",permalink:"/docs/learn/data-fetching/useterms"}},l={},p=[{value:"Basic Usage",id:"basic-usage",level:2},{value:"Return values",id:"return-values",level:3},{value:"single and archive params",id:"single-and-archive-params",level:3},{value:"priority",id:"priority",level:3},{value:"routeMatchStrategy",id:"routematchstrategy",level:3}],h={toc:p};function c(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},h,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"the-usepostorposts-hook"},"The usePostOrPosts hook"),(0,r.kt)("admonition",{type:"info"},(0,r.kt)("p",{parentName:"admonition"},"This hook was introduced in ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/core@1.1.0")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/next@1.1.0"))),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},"The ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next#usepostorposts"},"usePostOrPosts")," hook is the Next.js binding for the ",(0,r.kt)("a",{parentName:"p",href:"/api/namespaces/headstartwp_core.react#usefetchpostorposts"},"useFetchPostOrPosts"),".")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePostOrPosts")," fetch either a single post or a collection of posts based on the current path. It is useful when you want to prefix the archive and the single posts with the same prefix. E.g: /blog/post-name and /blog/news"),(0,r.kt)("h2",{id:"basic-usage"},"Basic Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},"// src/pages/blog/[...path].js\n\nconst blogParams = {\n single: {\n postType: 'post',\n },\n archive: {\n postType: 'post',\n taxonomy: 'category',\n },\n priority: 'single',\n routeMatchStrategy: 'single',\n};\n\nconst Archive = () => {\n const { data } = usePosts(blogParams.archive);\n\n return (\n <>\n

Blog Page

\n
    \n {data.posts.map((post) => (\n
  • \n {post.title.rendered}\n
    • \n ))}\n
\n \n );\n};\n\nconst PageContent = ({ params }) => {\n const { data } = usePost(params);\n\n return (\n <>\n

\n \n

\n \n \n );\n};\n\n\nconst BlogPage = () => {\n const { isArchive } = usePostOrPosts(blogParams);\n\n if (isArchive) {\n return ;\n }\n\n return ;\n};\n\nexport async function getServerSideProps(context) {\n try {\n const settledPromises = await resolveBatch([\n {\n func: fetchHookData(usePostOrPosts.fetcher(), context, { params: blogParams }),\n },\n ]);\n\n return addHookData(settledPromises, {});\n } catch (e) {\n return handleError(e, context);\n }\n}\n")),(0,r.kt)("p",null,"The above route will match the following URLs:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"/blog/","[category]"),(0,r.kt)("li",{parentName:"ul"},"/blog/","[category]","/page/","[page]"),(0,r.kt)("li",{parentName:"ul"},"/blog/","[category]","/","[post-name]"," (this route will only work if the ",(0,r.kt)("inlineCode",{parentName:"li"},"post.link")," property matches this structure in WP)"),(0,r.kt)("li",{parentName:"ul"},"/blog/","[post-name]"," (this route will only work if the ",(0,r.kt)("inlineCode",{parentName:"li"},"post.link")," property matches this structure in WP)")),(0,r.kt)("h3",{id:"return-values"},"Return values"),(0,r.kt)("p",null,"This hook returns the following things:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"isArchive"),": true if the resulting data is for an archive"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"isSingle"),": true if the resulting data is for a single post"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"post"),": if isSingle is true, will hold the data for a single post"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"posts"),": if isArchive is true, will hold the data for an archive")),(0,r.kt)("p",null,"When using the ",(0,r.kt)("inlineCode",{parentName:"p"},"usePostOrPosts")," hook you can also use ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," without needing to make additional fetch calls. The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePostOrPosts")," hook will populate the cache for ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts"),". That is why in the example on the page, the actual data is pulled from ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts"),"."),(0,r.kt)("h3",{id:"single-and-archive-params"},"single and archive params"),(0,r.kt)("p",null,"The route above is going to try to fetch either a single post or a post archive based on the current URL. The parameters passed to ",(0,r.kt)("inlineCode",{parentName:"p"},"single")," are the ",(0,r.kt)("inlineCode",{parentName:"p"},"usePost")," parameters and the ",(0,r.kt)("inlineCode",{parentName:"p"},"archive")," params are the ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," params."),(0,r.kt)("h3",{id:"priority"},"priority"),(0,r.kt)("p",null,"The possible values for ",(0,r.kt)("inlineCode",{parentName:"p"},"priority")," are ",(0,r.kt)("inlineCode",{parentName:"p"},"single")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"archive"),". This setting exists to prioritize one strategy over the other when there are URL collisions. In the example on this page, there could be a slug collision where a post exists with the slug of a category. In that case, the ",(0,r.kt)("inlineCode",{parentName:"p"},"priority")," setting will dictate which one is going to be used."),(0,r.kt)("h3",{id:"routematchstrategy"},"routeMatchStrategy"),(0,r.kt)("p",null,"This setting controls whether ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js")," should match the fetch strategy. The possible values are ",(0,r.kt)("inlineCode",{parentName:"p"},"none")," (default), ",(0,r.kt)("inlineCode",{parentName:"p"},"single"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"archive")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"both"),"."),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"single"),": Will only fetch a single post if ",(0,r.kt)("inlineCode",{parentName:"li"},"[...path].js")," matches the structure of a single."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"archive"),": Will only fetch an archive if ",(0,r.kt)("inlineCode",{parentName:"li"},"[...path].js")," matches the structure of an archive."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"both"),": Will only fetch a single and an archive if they both match the expected url structure."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"none"),": Does not perform any checks against ",(0,r.kt)("inlineCode",{parentName:"li"},"[...path].js"),".")),(0,r.kt)("p",null,"As an example, if you are trying to have ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog")," fetch the latest posts and ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog/post-name")," fetch a single post and set ",(0,r.kt)("inlineCode",{parentName:"p"},"routeMatchStrategy")," to ",(0,r.kt)("inlineCode",{parentName:"p"},"archive"),", the ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog")," route will never work."))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6eeb730f.e0c4a032.js b/assets/js/6eeb730f.090787cb.js similarity index 96% rename from assets/js/6eeb730f.e0c4a032.js rename to assets/js/6eeb730f.090787cb.js index 70590c54b..500b0d2d4 100644 --- a/assets/js/6eeb730f.e0c4a032.js +++ b/assets/js/6eeb730f.090787cb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7251],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var d=r.createContext({}),s=function(e){var t=r.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=s(e.components);return r.createElement(d.Provider,{value:t},e.children)},m="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,d=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),m=s(a),k=n,h=m["".concat(d,".").concat(k)]||m[k]||c[k]||i;return a?r.createElement(h,p(p({ref:t},o),{},{components:a})):r.createElement(h,p({ref:t},o))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=k;var l={};for(var d in t)hasOwnProperty.call(t,d)&&(l[d]=t[d]);l.originalType=e,l[m]="string"==typeof e?e:n,p[1]=l;for(var s=2;s{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>p,default:()=>m,frontMatter:()=>i,metadata:()=>l,toc:()=>s});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.TaxonomyTermsStrategy",title:"Class: TaxonomyTermsStrategy",sidebar_label:"@headstartwp/core.TaxonomyTermsStrategy",custom_edit_url:null},p=void 0,l={unversionedId:"classes/headstartwp_core.TaxonomyTermsStrategy",id:"classes/headstartwp_core.TaxonomyTermsStrategy",title:"Class: TaxonomyTermsStrategy",description:"@headstartwp/core.TaxonomyTermsStrategy",source:"@site/docs/classes/headstartwp_core.TaxonomyTermsStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.TaxonomyTermsStrategy",permalink:"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.TaxonomyTermsStrategy",title:"Class: TaxonomyTermsStrategy",sidebar_label:"@headstartwp/core.TaxonomyTermsStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.SinglePostFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy"},next:{title:"@headstartwp/core.Text",permalink:"/docs/api/classes/headstartwp_core.Text"}},d={},s=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"defaultTaxonomy",id:"defaulttaxonomy",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Overrides",id:"overrides-4",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-5",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getPreviewAuthHeader",id:"getpreviewauthheader",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getPreviewHeaderName",id:"getpreviewheadername",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-22",level:4}],o={toc:s};function m(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".TaxonomyTermsStrategy"),(0,n.kt)("p",null,"This fetch strategy does not support extracting url params from the url"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"TaxonomyArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"TaxonomyArchiveParams")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"TaxonomyTermsStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new TaxonomyTermsStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"TaxonomyArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"TaxonomyArchiveParams")))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L143"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:143")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L119"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:119")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaulttaxonomy"},"defaultTaxonomy"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultTaxonomy"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"'category'")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L103"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:103")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L124"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:124")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Builds the final endpoint URL based on the passed parameters"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to add to the request")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The endpoint URL."),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L122"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:122")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"The default fetcher function"),(0,n.kt)("p",null,"The default fetcher function handles authentication headers and errors from the API."),(0,n.kt)("p",null,"A custom strategy can override this function to run additional logic before or after the fetch call"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL to fetch")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetcher options")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L138"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:138")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"filterOptions?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"filterOptions?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"overrides-2"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L146"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:146")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L442"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:442")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L256"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:256")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L407"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:407")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides-3"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L105"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:105")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides-4"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L109"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:109")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L174"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:174")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Returns the supported params from the URL if present."),(0,n.kt)("p",null,"These params are passed to ",(0,n.kt)("inlineCode",{parentName:"p"},"buildEndpointURL"),". If the strategy does not support\nmapping url params to endpoint params, it should return an empty object."),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The Path name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"params extracted from the URL"),(0,n.kt)("h4",{id:"overrides-5"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L113"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:113")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewauthheader"},"getPreviewAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getpreviewauthheader"},"getPreviewAuthHeader")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L247"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:247")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewheadername"},"getPreviewHeaderName"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewHeaderName"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getpreviewheadername"},"getPreviewHeaderName")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L241"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:241")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L365"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:365")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L205"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:205")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L417"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:417")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L233"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:233")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-14"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-16"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L164"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:164")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-15"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-17"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")))}m.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7251],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var d=r.createContext({}),s=function(e){var t=r.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=s(e.components);return r.createElement(d.Provider,{value:t},e.children)},m="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,d=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),m=s(a),c=n,h=m["".concat(d,".").concat(c)]||m[c]||k[c]||i;return a?r.createElement(h,p(p({ref:t},o),{},{components:a})):r.createElement(h,p({ref:t},o))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=c;var l={};for(var d in t)hasOwnProperty.call(t,d)&&(l[d]=t[d]);l.originalType=e,l[m]="string"==typeof e?e:n,p[1]=l;for(var s=2;s{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>p,default:()=>m,frontMatter:()=>i,metadata:()=>l,toc:()=>s});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.TaxonomyTermsStrategy",title:"Class: TaxonomyTermsStrategy",sidebar_label:"@headstartwp/core.TaxonomyTermsStrategy",custom_edit_url:null},p=void 0,l={unversionedId:"classes/headstartwp_core.TaxonomyTermsStrategy",id:"classes/headstartwp_core.TaxonomyTermsStrategy",title:"Class: TaxonomyTermsStrategy",description:"@headstartwp/core.TaxonomyTermsStrategy",source:"@site/docs/classes/headstartwp_core.TaxonomyTermsStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.TaxonomyTermsStrategy",permalink:"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.TaxonomyTermsStrategy",title:"Class: TaxonomyTermsStrategy",sidebar_label:"@headstartwp/core.TaxonomyTermsStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.SinglePostFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy"},next:{title:"@headstartwp/core.Text",permalink:"/docs/api/classes/headstartwp_core.Text"}},d={},s=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"defaultTaxonomy",id:"defaulttaxonomy",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Overrides",id:"overrides-4",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-5",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getPreviewAuthHeader",id:"getpreviewauthheader",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getPreviewHeaderName",id:"getpreviewheadername",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-22",level:4}],o={toc:s};function m(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".TaxonomyTermsStrategy"),(0,n.kt)("p",null,"This fetch strategy does not support extracting url params from the url"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"TaxonomyArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"TaxonomyArchiveParams")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"TaxonomyTermsStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new TaxonomyTermsStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"TaxonomyArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"TaxonomyArchiveParams")))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L143"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:143")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L119"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:119")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaulttaxonomy"},"defaultTaxonomy"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultTaxonomy"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"'category'")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L103"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:103")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L124"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:124")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Builds the final endpoint URL based on the passed parameters"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to add to the request")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The endpoint URL."),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L122"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:122")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"The default fetcher function"),(0,n.kt)("p",null,"The default fetcher function handles authentication headers and errors from the API."),(0,n.kt)("p",null,"A custom strategy can override this function to run additional logic before or after the fetch call"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL to fetch")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetcher options")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L138"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:138")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"filterOptions?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"filterOptions?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"overrides-2"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L146"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:146")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L442"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:442")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L256"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:256")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L407"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:407")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides-3"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L105"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:105")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides-4"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L109"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:109")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L174"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:174")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Returns the supported params from the URL if present."),(0,n.kt)("p",null,"These params are passed to ",(0,n.kt)("inlineCode",{parentName:"p"},"buildEndpointURL"),". If the strategy does not support\nmapping url params to endpoint params, it should return an empty object."),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The Path name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"params extracted from the URL"),(0,n.kt)("h4",{id:"overrides-5"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/TaxonomyTermsStrategy.ts#L113"},"packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:113")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewauthheader"},"getPreviewAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getpreviewauthheader"},"getPreviewAuthHeader")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L247"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:247")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewheadername"},"getPreviewHeaderName"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewHeaderName"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getpreviewheadername"},"getPreviewHeaderName")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L241"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:241")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L365"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:365")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L205"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:205")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L417"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:417")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L233"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:233")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-14"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-16"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L164"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:164")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-15"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-17"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/6ef049a8.05151976.js b/assets/js/6ef049a8.3091bd4e.js similarity index 95% rename from assets/js/6ef049a8.05151976.js rename to assets/js/6ef049a8.3091bd4e.js index 4e8652853..39a25db08 100644 --- a/assets/js/6ef049a8.05151976.js +++ b/assets/js/6ef049a8.3091bd4e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1726],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),d=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},c=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),s=d(a),u=n,h=s["".concat(p,".").concat(u)]||s[u]||k[u]||i;return a?r.createElement(h,l(l({ref:t},c),{},{components:a})):r.createElement(h,l({ref:t},c))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=u;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,l[1]=o;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.AudioBlockProps",title:"Interface: AudioBlockProps",sidebar_label:"@headstartwp/core.react.AudioBlockProps",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.AudioBlockProps",id:"interfaces/headstartwp_core.react.AudioBlockProps",title:"Interface: AudioBlockProps",description:"@headstartwp/core.react.AudioBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.AudioBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.AudioBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.AudioBlockProps",title:"Interface: AudioBlockProps",sidebar_label:"@headstartwp/core.react.AudioBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.YoastSEOIntegration",permalink:"/docs/api/interfaces/headstartwp_core.YoastSEOIntegration"},next:{title:"@headstartwp/core.react.BlockAttributes",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockAttributes"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"autoplay",id:"autoplay",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"caption",id:"caption",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"loop",id:"loop",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"preload",id:"preload",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"src",id:"src",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-11",level:4}],c={toc:d};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".AudioBlockProps"),(0,n.kt)("p",null,"The interface for components rendered by ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#audioblock"},"AudioBlock")),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"AudioBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"autoplay"},"autoplay"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"autoplay"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Whether the audio should be autoplayable"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/AudioBlock.tsx#L19"},"packages/core/src/react/blocks/AudioBlock.tsx:19")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"caption"},"caption"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"caption"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Audio caption"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/AudioBlock.tsx#L24"},"packages/core/src/react/blocks/AudioBlock.tsx:24")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loop"},"loop"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"loop"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Whether the audio should be played in a loop"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/AudioBlock.tsx#L29"},"packages/core/src/react/blocks/AudioBlock.tsx:29")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"preload"},"preload"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"preload"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Whether to preload the audio or not"),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/AudioBlock.tsx#L34"},"packages/core/src/react/blocks/AudioBlock.tsx:34")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"src"},"src"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"src"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The audio source URL."),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/AudioBlock.tsx#L14"},"packages/core/src/react/blocks/AudioBlock.tsx:14")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1726],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),d=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},c=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),s=d(a),u=n,h=s["".concat(p,".").concat(u)]||s[u]||k[u]||i;return a?r.createElement(h,l(l({ref:t},c),{},{components:a})):r.createElement(h,l({ref:t},c))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=u;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,l[1]=o;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.AudioBlockProps",title:"Interface: AudioBlockProps",sidebar_label:"@headstartwp/core.react.AudioBlockProps",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.AudioBlockProps",id:"interfaces/headstartwp_core.react.AudioBlockProps",title:"Interface: AudioBlockProps",description:"@headstartwp/core.react.AudioBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.AudioBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.AudioBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.AudioBlockProps",title:"Interface: AudioBlockProps",sidebar_label:"@headstartwp/core.react.AudioBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.YoastSEOIntegration",permalink:"/docs/api/interfaces/headstartwp_core.YoastSEOIntegration"},next:{title:"@headstartwp/core.react.BlockAttributes",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockAttributes"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"autoplay",id:"autoplay",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"caption",id:"caption",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"loop",id:"loop",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"preload",id:"preload",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"src",id:"src",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-11",level:4}],c={toc:d};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".AudioBlockProps"),(0,n.kt)("p",null,"The interface for components rendered by ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#audioblock"},"AudioBlock")),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"AudioBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"autoplay"},"autoplay"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"autoplay"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Whether the audio should be autoplayable"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/AudioBlock.tsx#L19"},"packages/core/src/react/blocks/AudioBlock.tsx:19")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"caption"},"caption"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"caption"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Audio caption"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/AudioBlock.tsx#L24"},"packages/core/src/react/blocks/AudioBlock.tsx:24")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loop"},"loop"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"loop"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Whether the audio should be played in a loop"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/AudioBlock.tsx#L29"},"packages/core/src/react/blocks/AudioBlock.tsx:29")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"preload"},"preload"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"preload"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Whether to preload the audio or not"),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/AudioBlock.tsx#L34"},"packages/core/src/react/blocks/AudioBlock.tsx:34")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"src"},"src"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"src"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The audio source URL."),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/AudioBlock.tsx#L14"},"packages/core/src/react/blocks/AudioBlock.tsx:14")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/704c2a10.51fdd9c3.js b/assets/js/704c2a10.de9e6861.js similarity index 98% rename from assets/js/704c2a10.51fdd9c3.js rename to assets/js/704c2a10.de9e6861.js index d23881826..78a23d910 100644 --- a/assets/js/704c2a10.51fdd9c3.js +++ b/assets/js/704c2a10.de9e6861.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2779],{3905:(e,t,r)=>{r.d(t,{Zo:()=>i,kt:()=>f});var a=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function n(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function c(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var p=a.createContext({}),s=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):c(c({},t),e)),r},i=function(e){var t=s(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,o=e.mdxType,n=e.originalType,p=e.parentName,i=l(e,["components","mdxType","originalType","parentName"]),d=s(r),m=o,f=d["".concat(p,".").concat(m)]||d[m]||u[m]||n;return r?a.createElement(f,c(c({ref:t},i),{},{components:r})):a.createElement(f,c({ref:t},i))}));function f(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var n=r.length,c=new Array(n);c[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[d]="string"==typeof e?e:o,c[1]=l;for(var s=2;s{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>c,default:()=>d,frontMatter:()=>n,metadata:()=>l,toc:()=>s});var a=r(7462),o=(r(7294),r(3905));const n={id:"headstartwp_core.react.HtmlDecodeProps",title:"Interface: HtmlDecodeProps",sidebar_label:"@headstartwp/core.react.HtmlDecodeProps",custom_edit_url:null},c=void 0,l={unversionedId:"interfaces/headstartwp_core.react.HtmlDecodeProps",id:"interfaces/headstartwp_core.react.HtmlDecodeProps",title:"Interface: HtmlDecodeProps",description:"@headstartwp/core.react.HtmlDecodeProps",source:"@site/docs/interfaces/headstartwp_core.react.HtmlDecodeProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.HtmlDecodeProps",permalink:"/docs/api/interfaces/headstartwp_core.react.HtmlDecodeProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.HtmlDecodeProps",title:"Interface: HtmlDecodeProps",sidebar_label:"@headstartwp/core.react.HtmlDecodeProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.HookResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},next:{title:"@headstartwp/core.react.IAudioBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IAudioBlock"}},p={},s=[{value:"Properties",id:"properties",level:2},{value:"html",id:"html",level:3},{value:"Defined in",id:"defined-in",level:4}],i={toc:s};function d(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,a.Z)({},i,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,o.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".HtmlDecodeProps"),(0,o.kt)("h2",{id:"properties"},"Properties"),(0,o.kt)("h3",{id:"html"},"html"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"html"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")),(0,o.kt)("p",null,"The string with html entities to decode"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-jsx"},'\n')),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/HtmlDecoder.tsx#L13"},"packages/core/src/react/components/HtmlDecoder.tsx:13")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2779],{3905:(e,t,r)=>{r.d(t,{Zo:()=>i,kt:()=>f});var a=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function n(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function c(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var p=a.createContext({}),s=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):c(c({},t),e)),r},i=function(e){var t=s(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,o=e.mdxType,n=e.originalType,p=e.parentName,i=l(e,["components","mdxType","originalType","parentName"]),d=s(r),m=o,f=d["".concat(p,".").concat(m)]||d[m]||u[m]||n;return r?a.createElement(f,c(c({ref:t},i),{},{components:r})):a.createElement(f,c({ref:t},i))}));function f(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var n=r.length,c=new Array(n);c[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[d]="string"==typeof e?e:o,c[1]=l;for(var s=2;s{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>c,default:()=>d,frontMatter:()=>n,metadata:()=>l,toc:()=>s});var a=r(7462),o=(r(7294),r(3905));const n={id:"headstartwp_core.react.HtmlDecodeProps",title:"Interface: HtmlDecodeProps",sidebar_label:"@headstartwp/core.react.HtmlDecodeProps",custom_edit_url:null},c=void 0,l={unversionedId:"interfaces/headstartwp_core.react.HtmlDecodeProps",id:"interfaces/headstartwp_core.react.HtmlDecodeProps",title:"Interface: HtmlDecodeProps",description:"@headstartwp/core.react.HtmlDecodeProps",source:"@site/docs/interfaces/headstartwp_core.react.HtmlDecodeProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.HtmlDecodeProps",permalink:"/docs/api/interfaces/headstartwp_core.react.HtmlDecodeProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.HtmlDecodeProps",title:"Interface: HtmlDecodeProps",sidebar_label:"@headstartwp/core.react.HtmlDecodeProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.HookResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},next:{title:"@headstartwp/core.react.IAudioBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IAudioBlock"}},p={},s=[{value:"Properties",id:"properties",level:2},{value:"html",id:"html",level:3},{value:"Defined in",id:"defined-in",level:4}],i={toc:s};function d(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,a.Z)({},i,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,o.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".HtmlDecodeProps"),(0,o.kt)("h2",{id:"properties"},"Properties"),(0,o.kt)("h3",{id:"html"},"html"),(0,o.kt)("p",null,"\u2022 ",(0,o.kt)("strong",{parentName:"p"},"html"),": ",(0,o.kt)("inlineCode",{parentName:"p"},"string")),(0,o.kt)("p",null,"The string with html entities to decode"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-jsx"},'\n')),(0,o.kt)("h4",{id:"defined-in"},"Defined in"),(0,o.kt)("p",null,(0,o.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/HtmlDecoder.tsx#L13"},"packages/core/src/react/components/HtmlDecoder.tsx:13")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/7272e25f.1c16dba0.js b/assets/js/7272e25f.bf21103b.js similarity index 90% rename from assets/js/7272e25f.1c16dba0.js rename to assets/js/7272e25f.bf21103b.js index b84c8346e..d1ecbb45d 100644 --- a/assets/js/7272e25f.1c16dba0.js +++ b/assets/js/7272e25f.bf21103b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7895],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),s=c(r),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return r?a.createElement(h,o(o({ref:t},d),{},{components:r})):a.createElement(h,o({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[s]="string"==typeof e?e:n,o[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.ButtonsBlockProps",title:"Interface: ButtonsBlockProps",sidebar_label:"@headstartwp/core.react.ButtonsBlockProps",custom_edit_url:null},o=void 0,l={unversionedId:"interfaces/headstartwp_core.react.ButtonsBlockProps",id:"interfaces/headstartwp_core.react.ButtonsBlockProps",title:"Interface: ButtonsBlockProps",description:"@headstartwp/core.react.ButtonsBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.ButtonsBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ButtonsBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ButtonsBlockProps",title:"Interface: ButtonsBlockProps",sidebar_label:"@headstartwp/core.react.ButtonsBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ButtonBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps"},next:{title:"@headstartwp/core.react.CodeBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ButtonsBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ButtonsBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7895],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},s=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),d=c(r),m=n,h=d["".concat(p,".").concat(m)]||d[m]||k[m]||i;return r?a.createElement(h,o(o({ref:t},s),{},{components:r})):a.createElement(h,o({ref:t},s))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[d]="string"==typeof e?e:n,o[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.ButtonsBlockProps",title:"Interface: ButtonsBlockProps",sidebar_label:"@headstartwp/core.react.ButtonsBlockProps",custom_edit_url:null},o=void 0,l={unversionedId:"interfaces/headstartwp_core.react.ButtonsBlockProps",id:"interfaces/headstartwp_core.react.ButtonsBlockProps",title:"Interface: ButtonsBlockProps",description:"@headstartwp/core.react.ButtonsBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.ButtonsBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ButtonsBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ButtonsBlockProps",title:"Interface: ButtonsBlockProps",sidebar_label:"@headstartwp/core.react.ButtonsBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ButtonBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps"},next:{title:"@headstartwp/core.react.CodeBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],s={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ButtonsBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ButtonsBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/7360f818.685fbced.js b/assets/js/7360f818.32d4354d.js similarity index 90% rename from assets/js/7360f818.685fbced.js rename to assets/js/7360f818.32d4354d.js index 19483895a..a32d6a132 100644 --- a/assets/js/7360f818.685fbced.js +++ b/assets/js/7360f818.32d4354d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6875],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>f});var n=a(7294);function i(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function d(e){for(var t=1;t=0||(i[a]=e[a]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var s=n.createContext({}),l=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):d(d({},t),e)),a},o=function(e){var t=l(e.components);return n.createElement(s.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,o=p(e,["components","mdxType","originalType","parentName"]),c=l(a),k=i,f=c["".concat(s,".").concat(k)]||c[k]||h[k]||r;return a?n.createElement(f,d(d({ref:t},o),{},{components:a})):n.createElement(f,d({ref:t},o))}));function f(e,t){var a=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=a.length,d=new Array(r);d[0]=k;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[c]="string"==typeof e?e:i,d[1]=p;for(var l=2;l{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>d,default:()=>c,frontMatter:()=>r,metadata:()=>p,toc:()=>l});var n=a(7462),i=(a(7294),a(3905));const r={id:"headstartwp_core.PageEntity",title:"Interface: PageEntity",sidebar_label:"@headstartwp/core.PageEntity",custom_edit_url:null},d=void 0,p={unversionedId:"interfaces/headstartwp_core.PageEntity",id:"interfaces/headstartwp_core.PageEntity",title:"Interface: PageEntity",description:"@headstartwp/core.PageEntity",source:"@site/docs/interfaces/headstartwp_core.PageEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PageEntity",permalink:"/docs/api/interfaces/headstartwp_core.PageEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PageEntity",title:"Interface: PageEntity",sidebar_label:"@headstartwp/core.PageEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.MenuItemEntity",permalink:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"},next:{title:"@headstartwp/core.PageInfo",permalink:"/docs/api/interfaces/headstartwp_core.PageInfo"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embedded",id:"_embedded",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"author",id:"author",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"comment_status",id:"comment_status",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"content",id:"content",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"date",id:"date",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"date_gmt",id:"date_gmt",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"excerpt",id:"excerpt",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"featured_media",id:"featured_media",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"guid",id:"guid",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"link",id:"link",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"menu_order",id:"menu_order",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"meta",id:"meta",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"modified",id:"modified",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"modified_gmt",id:"modified_gmt",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"parent",id:"parent",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"ping_status",id:"ping_status",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"slug",id:"slug",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"status",id:"status",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"template",id:"template",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"terms",id:"terms",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"type",id:"type",level:3},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-24",level:4}],o={toc:l};function c(e){let{components:t,...a}=e;return(0,i.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PageEntity"),(0,i.kt)("p",null,"Interface for entities from the /wp/v2/pages endpoint."),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"PostTypeEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"PageEntity"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"_embedded"},"_","embedded"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"_","embedded"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"author")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wp:term")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]")))),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#_embedded"},"_embedded")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L98"},"packages/core/src/data/types/entities.ts:98")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"author"},"author"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"author"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#author"},"author")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L94"},"packages/core/src/data/types/entities.ts:94")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"comment_status"},"comment","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"comment","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not comments are open on the object."),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#comment_status"},"comment_status")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L106"},"packages/core/src/data/types/entities.ts:106")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"content"},"content"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"content"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The content for the object."),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L209"},"packages/core/src/data/types/entities.ts:209")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date"},"date"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date"},"date")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L42"},"packages/core/src/data/types/entities.ts:42")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date_gmt"},"date","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, as GMT."),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date_gmt"},"date_gmt")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L47"},"packages/core/src/data/types/entities.ts:47")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"excerpt"},"excerpt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"excerpt"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The excerpt for the object."),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L214"},"packages/core/src/data/types/entities.ts:214")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"featured_media"},"featured","_","media"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"featured","_","media"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The ID of the featured media for the object."),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L234"},"packages/core/src/data/types/entities.ts:234")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"guid"},"guid"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"guid"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The globally unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#guid"},"guid")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L52"},"packages/core/src/data/types/entities.ts:52")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"id"},"id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#id"},"id")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L67"},"packages/core/src/data/types/entities.ts:67")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"link"},"link"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"link"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"URL to the object."),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#link"},"link")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L72"},"packages/core/src/data/types/entities.ts:72")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"menu_order"},"menu","_","order"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"menu","_","order"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The order of the object in relation to other object of its type."),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L219"},"packages/core/src/data/types/entities.ts:219")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"meta"},"meta"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"meta"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,i.kt)("p",null,"Meta fields."),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L224"},"packages/core/src/data/types/entities.ts:224")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified"},"modified"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified"},"modified")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L57"},"packages/core/src/data/types/entities.ts:57")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified_gmt"},"modified","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, as GMT."),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified_gmt"},"modified_gmt")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L62"},"packages/core/src/data/types/entities.ts:62")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"parent"},"parent"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"parent"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The ID for the parent of the object."),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L204"},"packages/core/src/data/types/entities.ts:204")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ping_status"},"ping","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ping","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not the object can be pinged."),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#ping_status"},"ping_status")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L111"},"packages/core/src/data/types/entities.ts:111")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"slug"},"slug"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"slug"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"An alphanumeric identifier for the object unique to its type."),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#slug"},"slug")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L77"},"packages/core/src/data/types/entities.ts:77")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"status"},"status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"publish"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"future"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"draft"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"pending"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"private"')),(0,i.kt)("p",null,"A named status for the object."),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#status"},"status")),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L82"},"packages/core/src/data/types/entities.ts:82")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"template"},"template"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"template"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The theme file to use to display the object."),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L229"},"packages/core/src/data/types/entities.ts:229")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"terms"},"terms"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"terms"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,i.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#terms"},"terms")),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L96"},"packages/core/src/data/types/entities.ts:96")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The title for the object."),(0,i.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#title"},"title")),(0,i.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L92"},"packages/core/src/data/types/entities.ts:92")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"type"},"type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Type of Post for the object."),(0,i.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#type"},"type")),(0,i.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L87"},"packages/core/src/data/types/entities.ts:87")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head"},"yoast_head")),(0,i.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L114"},"packages/core/src/data/types/entities.ts:114")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head_json"},"yoast_head_json")),(0,i.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L113"},"packages/core/src/data/types/entities.ts:113")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6875],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>f});var n=a(7294);function i(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(i[a]=e[a]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var s=n.createContext({}),l=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=l(e.components);return n.createElement(s.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),c=l(a),k=i,f=c["".concat(s,".").concat(k)]||c[k]||h[k]||r;return a?n.createElement(f,p(p({ref:t},o),{},{components:a})):n.createElement(f,p({ref:t},o))}));function f(e,t){var a=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=a.length,p=new Array(r);p[0]=k;var d={};for(var s in t)hasOwnProperty.call(t,s)&&(d[s]=t[s]);d.originalType=e,d[c]="string"==typeof e?e:i,p[1]=d;for(var l=2;l{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>c,frontMatter:()=>r,metadata:()=>d,toc:()=>l});var n=a(7462),i=(a(7294),a(3905));const r={id:"headstartwp_core.PageEntity",title:"Interface: PageEntity",sidebar_label:"@headstartwp/core.PageEntity",custom_edit_url:null},p=void 0,d={unversionedId:"interfaces/headstartwp_core.PageEntity",id:"interfaces/headstartwp_core.PageEntity",title:"Interface: PageEntity",description:"@headstartwp/core.PageEntity",source:"@site/docs/interfaces/headstartwp_core.PageEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PageEntity",permalink:"/docs/api/interfaces/headstartwp_core.PageEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PageEntity",title:"Interface: PageEntity",sidebar_label:"@headstartwp/core.PageEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.MenuItemEntity",permalink:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"},next:{title:"@headstartwp/core.PageInfo",permalink:"/docs/api/interfaces/headstartwp_core.PageInfo"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embedded",id:"_embedded",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"author",id:"author",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"comment_status",id:"comment_status",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"content",id:"content",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"date",id:"date",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"date_gmt",id:"date_gmt",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"excerpt",id:"excerpt",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"featured_media",id:"featured_media",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"guid",id:"guid",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"link",id:"link",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"menu_order",id:"menu_order",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"meta",id:"meta",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"modified",id:"modified",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"modified_gmt",id:"modified_gmt",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"parent",id:"parent",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"ping_status",id:"ping_status",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"slug",id:"slug",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"status",id:"status",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"template",id:"template",level:3},{value:"Defined in",id:"defined-in-19",level:4},{value:"terms",id:"terms",level:3},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"type",id:"type",level:3},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-24",level:4}],o={toc:l};function c(e){let{components:t,...a}=e;return(0,i.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PageEntity"),(0,i.kt)("p",null,"Interface for entities from the /wp/v2/pages endpoint."),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"PostTypeEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"PageEntity"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"_embedded"},"_","embedded"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"_","embedded"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"author")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wp:term")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]")))),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#_embedded"},"_embedded")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L98"},"packages/core/src/data/types/entities.ts:98")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"author"},"author"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"author"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#author"},"author")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L94"},"packages/core/src/data/types/entities.ts:94")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"comment_status"},"comment","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"comment","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not comments are open on the object."),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#comment_status"},"comment_status")),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L106"},"packages/core/src/data/types/entities.ts:106")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"content"},"content"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"content"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The content for the object."),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L209"},"packages/core/src/data/types/entities.ts:209")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date"},"date"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date"},"date")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L42"},"packages/core/src/data/types/entities.ts:42")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date_gmt"},"date","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, as GMT."),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#date_gmt"},"date_gmt")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L47"},"packages/core/src/data/types/entities.ts:47")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"excerpt"},"excerpt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"excerpt"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The excerpt for the object."),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L214"},"packages/core/src/data/types/entities.ts:214")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"featured_media"},"featured","_","media"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"featured","_","media"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The ID of the featured media for the object."),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L234"},"packages/core/src/data/types/entities.ts:234")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"guid"},"guid"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"guid"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The globally unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#guid"},"guid")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L52"},"packages/core/src/data/types/entities.ts:52")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"id"},"id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Unique identifier for the object."),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#id"},"id")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L67"},"packages/core/src/data/types/entities.ts:67")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"link"},"link"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"link"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"URL to the object."),(0,i.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#link"},"link")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L72"},"packages/core/src/data/types/entities.ts:72")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"menu_order"},"menu","_","order"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"menu","_","order"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The order of the object in relation to other object of its type."),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L219"},"packages/core/src/data/types/entities.ts:219")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"meta"},"meta"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"meta"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,i.kt)("p",null,"Meta fields."),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L224"},"packages/core/src/data/types/entities.ts:224")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified"},"modified"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, in the site's timezone."),(0,i.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified"},"modified")),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L57"},"packages/core/src/data/types/entities.ts:57")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified_gmt"},"modified","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, as GMT."),(0,i.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#modified_gmt"},"modified_gmt")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L62"},"packages/core/src/data/types/entities.ts:62")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"parent"},"parent"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"parent"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"The ID for the parent of the object."),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L204"},"packages/core/src/data/types/entities.ts:204")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ping_status"},"ping","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ping","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not the object can be pinged."),(0,i.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#ping_status"},"ping_status")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L111"},"packages/core/src/data/types/entities.ts:111")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"slug"},"slug"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"slug"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"An alphanumeric identifier for the object unique to its type."),(0,i.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#slug"},"slug")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L77"},"packages/core/src/data/types/entities.ts:77")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"status"},"status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"publish"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"future"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"draft"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"pending"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"private"')),(0,i.kt)("p",null,"A named status for the object."),(0,i.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#status"},"status")),(0,i.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L82"},"packages/core/src/data/types/entities.ts:82")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"template"},"template"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"template"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The theme file to use to display the object."),(0,i.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L229"},"packages/core/src/data/types/entities.ts:229")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"terms"},"terms"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"terms"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,i.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#terms"},"terms")),(0,i.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L96"},"packages/core/src/data/types/entities.ts:96")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The title for the object."),(0,i.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#title"},"title")),(0,i.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L92"},"packages/core/src/data/types/entities.ts:92")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"type"},"type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Type of Post for the object."),(0,i.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#type"},"type")),(0,i.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L87"},"packages/core/src/data/types/entities.ts:87")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head"},"yoast_head")),(0,i.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L114"},"packages/core/src/data/types/entities.ts:114")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},"PostTypeEntity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity#yoast_head_json"},"yoast_head_json")),(0,i.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L113"},"packages/core/src/data/types/entities.ts:113")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/74bdc397.1942c389.js b/assets/js/74bdc397.1942c389.js deleted file mode 100644 index 163de68cd..000000000 --- a/assets/js/74bdc397.1942c389.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[918],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>u});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var s=r.createContext({}),c=function(e){var t=r.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(s.Provider,{value:t},e.children)},l="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,s=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),l=c(a),k=n,u=l["".concat(s,".").concat(k)]||l[k]||h[k]||o;return a?r.createElement(u,i(i({ref:t},d),{},{components:a})):r.createElement(u,i({ref:t},d))}));function u(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,i=new Array(o);i[0]=k;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[l]="string"==typeof e?e:n,i[1]=p;for(var c=2;c{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>p,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.useSearchResponse",title:"Interface: useSearchResponse",sidebar_label:"@headstartwp/core.react.useSearchResponse",custom_edit_url:null},i=void 0,p={unversionedId:"interfaces/headstartwp_core.react.useSearchResponse",id:"interfaces/headstartwp_core.react.useSearchResponse",title:"Interface: useSearchResponse",description:"@headstartwp/core.react.useSearchResponse",source:"@site/docs/interfaces/headstartwp_core.react.useSearchResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.useSearchResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.useSearchResponse",title:"Interface: useSearchResponse",sidebar_label:"@headstartwp/core.react.useSearchResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.useSearchNativeResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useSearchNativeResponse"},next:{title:"@headstartwp/core.react.useTermsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse"}},s={},c=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],d={toc:c};function l(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".useSearchResponse"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"useSearchResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"pageInfo")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"posts")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"queriedObject")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject")))))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/useFetchSearch.ts#L18"},"packages/core/src/react/hooks/useFetchSearch.ts:18")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")))}l.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/74bdc397.8fe22a22.js b/assets/js/74bdc397.8fe22a22.js new file mode 100644 index 000000000..b49e1fc31 --- /dev/null +++ b/assets/js/74bdc397.8fe22a22.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[918],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>u});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var s=r.createContext({}),c=function(e){var t=r.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(s.Provider,{value:t},e.children)},l="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,s=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),l=c(a),k=n,u=l["".concat(s,".").concat(k)]||l[k]||h[k]||o;return a?r.createElement(u,i(i({ref:t},d),{},{components:a})):r.createElement(u,i({ref:t},d))}));function u(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,i=new Array(o);i[0]=k;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[l]="string"==typeof e?e:n,i[1]=p;for(var c=2;c{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>p,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.useSearchResponse",title:"Interface: useSearchResponse",sidebar_label:"@headstartwp/core.react.useSearchResponse",custom_edit_url:null},i=void 0,p={unversionedId:"interfaces/headstartwp_core.react.useSearchResponse",id:"interfaces/headstartwp_core.react.useSearchResponse",title:"Interface: useSearchResponse",description:"@headstartwp/core.react.useSearchResponse",source:"@site/docs/interfaces/headstartwp_core.react.useSearchResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.useSearchResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.useSearchResponse",title:"Interface: useSearchResponse",sidebar_label:"@headstartwp/core.react.useSearchResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.useSearchNativeResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useSearchNativeResponse"},next:{title:"@headstartwp/core.react.useTermsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse"}},s={},c=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"mutate",id:"mutate",level:3},{value:"Defined in",id:"defined-in-4",level:4}],d={toc:c};function l(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".useSearchResponse"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"useSearchResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"pageInfo")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"posts")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"queriedObject")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject")))))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetchSearch.ts#L19"},"packages/core/src/react/hooks/useFetchSearch.ts:19")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"mutate"},"mutate"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"mutate"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"KeyedMutator"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetchSearch.ts#L20"},"packages/core/src/react/hooks/useFetchSearch.ts:20")))}l.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/76bd5e23.e965ae36.js b/assets/js/76bd5e23.2155ff72.js similarity index 96% rename from assets/js/76bd5e23.e965ae36.js rename to assets/js/76bd5e23.2155ff72.js index 01d8204b5..304148941 100644 --- a/assets/js/76bd5e23.e965ae36.js +++ b/assets/js/76bd5e23.2155ff72.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9621],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function o(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),c=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},d=function(e){var t=c(e.components);return n.createElement(p.Provider,{value:t},e.children)},s="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),k=r,h=s["".concat(p,".").concat(k)]||s[k]||m[k]||l;return a?n.createElement(h,o(o({ref:t},d),{},{components:a})):n.createElement(h,o({ref:t},d))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,o=new Array(l);o[0]=k;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:r,o[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>l,metadata:()=>i,toc:()=>c});var n=a(7462),r=(a(7294),a(3905));const l={id:"headstartwp_core.react.IColumnsBlock",title:"Interface: IColumnsBlock",sidebar_label:"@headstartwp/core.react.IColumnsBlock",custom_edit_url:null},o=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IColumnsBlock",id:"interfaces/headstartwp_core.react.IColumnsBlock",title:"Interface: IColumnsBlock",description:"@headstartwp/core.react.IColumnsBlock",source:"@site/docs/interfaces/headstartwp_core.react.IColumnsBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IColumnsBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IColumnsBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IColumnsBlock",title:"Interface: IColumnsBlock",sidebar_label:"@headstartwp/core.react.IColumnsBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IColumnBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IColumnBlock"},next:{title:"@headstartwp/core.react.ICoverBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ICoverBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IColumnsBlock"),(0,r.kt)("p",null,"The common interface for a block transform component"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ColumnsBlockProps")),">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"IColumnsBlock"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"children"},"children"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"children"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,r.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,r.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classlist"},"classList"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"classList"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classname"},"className"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"className"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"component"},"component"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"component"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ColumnsBlockProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ColumnsBlockProps")))))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domnode"},"domNode"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"domNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,r.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,r.kt)("h5",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"childNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h5",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"style"},"style"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"style"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The style tag of the domNode as an object."),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tagname"},"tagName"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tagName"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9621],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function o(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),c=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},d=function(e){var t=c(e.components);return n.createElement(p.Provider,{value:t},e.children)},s="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},k=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,l=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),k=r,h=s["".concat(p,".").concat(k)]||s[k]||m[k]||l;return a?n.createElement(h,o(o({ref:t},d),{},{components:a})):n.createElement(h,o({ref:t},d))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var l=a.length,o=new Array(l);o[0]=k;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:r,o[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>l,metadata:()=>i,toc:()=>c});var n=a(7462),r=(a(7294),a(3905));const l={id:"headstartwp_core.react.IColumnsBlock",title:"Interface: IColumnsBlock",sidebar_label:"@headstartwp/core.react.IColumnsBlock",custom_edit_url:null},o=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IColumnsBlock",id:"interfaces/headstartwp_core.react.IColumnsBlock",title:"Interface: IColumnsBlock",description:"@headstartwp/core.react.IColumnsBlock",source:"@site/docs/interfaces/headstartwp_core.react.IColumnsBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IColumnsBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IColumnsBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IColumnsBlock",title:"Interface: IColumnsBlock",sidebar_label:"@headstartwp/core.react.IColumnsBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IColumnBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IColumnBlock"},next:{title:"@headstartwp/core.react.ICoverBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ICoverBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IColumnsBlock"),(0,r.kt)("p",null,"The common interface for a block transform component"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ColumnsBlockProps")),">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"IColumnsBlock"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"children"},"children"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"children"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,r.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,r.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classlist"},"classList"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"classList"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classname"},"className"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"className"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"component"},"component"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"component"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ColumnsBlockProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ColumnsBlockProps")))))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domnode"},"domNode"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"domNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,r.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,r.kt)("h5",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"childNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h5",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"style"},"style"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"style"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The style tag of the domNode as an object."),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tagname"},"tagName"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tagName"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/7721a5b2.65e13590.js b/assets/js/7721a5b2.f1ac6cf3.js similarity index 98% rename from assets/js/7721a5b2.65e13590.js rename to assets/js/7721a5b2.f1ac6cf3.js index e0e1b054c..ddc269884 100644 --- a/assets/js/7721a5b2.65e13590.js +++ b/assets/js/7721a5b2.f1ac6cf3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5182],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>m});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var l=n.createContext({}),p=function(e){var t=n.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},c=function(e){var t=p(e.components);return n.createElement(l.Provider,{value:t},e.children)},u="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,o=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),u=p(a),d=r,m=u["".concat(l,".").concat(d)]||u[d]||h[d]||o;return a?n.createElement(m,i(i({ref:t},c),{},{components:a})):n.createElement(m,i({ref:t},c))}));function m(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=a.length,i=new Array(o);i[0]=d;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[u]="string"==typeof e?e:r,i[1]=s;for(var p=2;p{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>p});var n=a(7462),r=(a(7294),a(3905));const o={slug:"/data-fetching/useposts",sidebar_position:2},i="The usePosts hook",s={unversionedId:"Data Fetching/usePosts",id:"Data Fetching/usePosts",title:"The usePosts hook",description:"The usePosts hook is the Next.js binding for the useFetchPosts.",source:"@site/documentation/02 - Data Fetching/usePosts.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/useposts",permalink:"/docs/learn/data-fetching/useposts",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/usePosts.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",sidebarPosition:2,frontMatter:{slug:"/data-fetching/useposts",sidebar_position:2},sidebar:"tutorialSidebar",previous:{title:"The usePost hook",permalink:"/docs/learn/data-fetching/usepost"},next:{title:"The useAuthorArchive Hook",permalink:"/docs/learn/data-fetching/useauthorarchive"}},l={},p=[{value:"Basic Usage",id:"basic-usage",level:2},{value:"Queried Object",id:"queried-object",level:2},{value:"Category Archive",id:"category-archive",level:2},{value:"Archive Path Matching",id:"archive-path-matching",level:2},{value:"Known limitations",id:"known-limitations",level:2}],c={toc:p};function u(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"the-useposts-hook"},"The usePosts hook"),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},"The ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next#useposts"},"usePosts")," hook is the Next.js binding for the ",(0,r.kt)("a",{parentName:"p",href:"/api/namespaces/headstartwp_core.react#usefetchposts"},"useFetchPosts"),".")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," hook fetches a collection of WordPress posts from a registered post type. Its basic usage is very simple."),(0,r.kt)("h2",{id:"basic-usage"},"Basic Usage"),(0,r.kt)("p",null,"Assuming a ",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/blog/[[...path]].js")," route with the following content."),(0,r.kt)("admonition",{type:"info"},(0,r.kt)("p",{parentName:"admonition"},"This example is using the optional catch-all route ",(0,r.kt)("inlineCode",{parentName:"p"},"[[..path]].js")," because we want the ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog")," route to be handled by the same file.")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/blog/[[...path]].js"',title:'"src/pages/blog/[[...path]].js"'},"import { usePost } from '@headstartwp/next';\n\nconst ArchivePage = () => {\n const { loading, error, data } = usePosts({ per_page: 10 });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n {data?.posts?.map((post) => (\n

{post.title.rendered}

\n ))}\n
\n );\n};\n")),(0,r.kt)("p",null,"The route will automatically render the latest 10 posts and you get pagination, category, tags and custom taxonomies filtering for free as the following paths will automatically map URL segments into REST API requests:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"/blog/page/2"),(0,r.kt)("li",{parentName:"ul"},"/blog/category/category-name"),(0,r.kt)("li",{parentName:"ul"},"/blog/tag/tag-name"),(0,r.kt)("li",{parentName:"ul"},"/blog/category/category-name/page/2")),(0,r.kt)("h2",{id:"queried-object"},"Queried Object"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," hook exposes a ",(0,r.kt)("inlineCode",{parentName:"p"},"queriedObject"),". It's similar to WordPress ",(0,r.kt)("a",{parentName:"p",href:"https://developer.wordpress.org/reference/functions/get_queried_object/"},"get_queried_object()")," function."),(0,r.kt)("p",null,"It essentially returns what's being queried for, e.g., author or category. If the current page is querying posts within a certain author, then that author object will be populated in ",(0,r.kt)("inlineCode",{parentName:"p"},"data.queriedObject.author"),". Similarly, if the current page is querying posts from a given category ",(0,r.kt)("inlineCode",{parentName:"p"},"data.queriedObject.term")," will be populated with that category."),(0,r.kt)("p",null,"Example: "),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},"// category-name can either come from the URL or be manually specified.\nconst { data } = usePosts({ taxonomy: 'category', category: 'cat-name' });\n\nreturn (\n

Category Page: {data.queriedObject.term.name}

\n);\n")),(0,r.kt)("h2",{id:"category-archive"},"Category Archive"),(0,r.kt)("p",null,"You can use the ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," hook to create a category archive route (",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/category/[...path].js"),")."),(0,r.kt)("admonition",{type:"info"},(0,r.kt)("p",{parentName:"admonition"},"We use ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js")," here because ",(0,r.kt)("strong",{parentName:"p"},"we do not want")," the ",(0,r.kt)("inlineCode",{parentName:"p"},"/category")," route to render anything.")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/category/[...path].js"',title:'"src/pages/category/[...path].js"'},"import {\n usePosts,\n fetchHookData,\n addHookData,\n handleError,\n} from '@headstartwp/next';\n\nconst CategoryPage = () => {\n const { data } = usePosts({ taxonomy: 'category' });\n\n return (\n <>\n

Category Page: {data.queriedObject.term.name}

\n
    \n {data.posts.map((post) => (\n
  • \n {post.title.rendered}\n
    • \n ))}\n
\n \n \n );\n};\n")),(0,r.kt)("h2",{id:"archive-path-matching"},"Archive Path Matching"),(0,r.kt)("p",null,"When using ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts"),' to create archive pages (e.g. a category archive) you can optionally enable "archive path matching" to ensure that your archive routes match the expected permalink dictated by WordPress. Without "archive path matching", your archive routes would match as long as the last segment of the url is a valid term slug. '),(0,r.kt)("p",null,"For instance, let's take the ",(0,r.kt)("inlineCode",{parentName:"p"},"/category/[...path].js")," route above. It will match URLs like:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"/category/cat-name"),(0,r.kt)("li",{parentName:"ul"},"/category/parent-cat-name/cat-name")),(0,r.kt)("p",null,"The framework, however, does not check if ",(0,r.kt)("inlineCode",{parentName:"p"},"parent-cat-name")," is the de facto parent of cat-name, and even worse, it has no way to know (without additional rest api calls) if ",(0,r.kt)("inlineCode",{parentName:"p"},"parent-cat-name")," is even a valid category."),(0,r.kt)("p",null,"To address this, you can pass ",(0,r.kt)("inlineCode",{parentName:"p"},"matchArchivePath")," to ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," to tell the framework to check the ",(0,r.kt)("inlineCode",{parentName:"p"},"link")," property of the ",(0,r.kt)("inlineCode",{parentName:"p"},"queriedObject"),", i.e if the ",(0,r.kt)("inlineCode",{parentName:"p"},"link")," property of ",(0,r.kt)("inlineCode",{parentName:"p"},"cat-name")," returned by the ",(0,r.kt)("a",{parentName:"p",href:"https://developer.wordpress.org/rest-api/reference/categories/#schema"},"WordPress REST API")," matches the front-end path."),(0,r.kt)("p",null,"This setting can also be enabled in ",(0,r.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," globally."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"module.exports = {\n // enable archive path mapping for all default taxonomies\n customTaxonomies: (defaultTaxonomies) => {\n return defaultTaxonomies.map((taxonomy) => ({ ...taxonomy, matchArchivePath: true })),\n },\n}\n")),(0,r.kt)("h2",{id:"known-limitations"},"Known limitations"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"It is not possible to fetch posts from more than one post type.")))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5182],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>m});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var l=n.createContext({}),p=function(e){var t=n.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},c=function(e){var t=p(e.components);return n.createElement(l.Provider,{value:t},e.children)},u="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,o=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),u=p(a),d=r,m=u["".concat(l,".").concat(d)]||u[d]||h[d]||o;return a?n.createElement(m,i(i({ref:t},c),{},{components:a})):n.createElement(m,i({ref:t},c))}));function m(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=a.length,i=new Array(o);i[0]=d;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[u]="string"==typeof e?e:r,i[1]=s;for(var p=2;p{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>p});var n=a(7462),r=(a(7294),a(3905));const o={slug:"/data-fetching/useposts",sidebar_position:2},i="The usePosts hook",s={unversionedId:"Data Fetching/usePosts",id:"Data Fetching/usePosts",title:"The usePosts hook",description:"The usePosts hook is the Next.js binding for the useFetchPosts.",source:"@site/documentation/02 - Data Fetching/usePosts.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/useposts",permalink:"/docs/learn/data-fetching/useposts",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/usePosts.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",sidebarPosition:2,frontMatter:{slug:"/data-fetching/useposts",sidebar_position:2},sidebar:"tutorialSidebar",previous:{title:"The usePost hook",permalink:"/docs/learn/data-fetching/usepost"},next:{title:"The useAuthorArchive Hook",permalink:"/docs/learn/data-fetching/useauthorarchive"}},l={},p=[{value:"Basic Usage",id:"basic-usage",level:2},{value:"Queried Object",id:"queried-object",level:2},{value:"Category Archive",id:"category-archive",level:2},{value:"Archive Path Matching",id:"archive-path-matching",level:2},{value:"Known limitations",id:"known-limitations",level:2}],c={toc:p};function u(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"the-useposts-hook"},"The usePosts hook"),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},"The ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next#useposts"},"usePosts")," hook is the Next.js binding for the ",(0,r.kt)("a",{parentName:"p",href:"/api/namespaces/headstartwp_core.react#usefetchposts"},"useFetchPosts"),".")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," hook fetches a collection of WordPress posts from a registered post type. Its basic usage is very simple."),(0,r.kt)("h2",{id:"basic-usage"},"Basic Usage"),(0,r.kt)("p",null,"Assuming a ",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/blog/[[...path]].js")," route with the following content."),(0,r.kt)("admonition",{type:"info"},(0,r.kt)("p",{parentName:"admonition"},"This example is using the optional catch-all route ",(0,r.kt)("inlineCode",{parentName:"p"},"[[..path]].js")," because we want the ",(0,r.kt)("inlineCode",{parentName:"p"},"/blog")," route to be handled by the same file.")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/blog/[[...path]].js"',title:'"src/pages/blog/[[...path]].js"'},"import { usePost } from '@headstartwp/next';\n\nconst ArchivePage = () => {\n const { loading, error, data } = usePosts({ per_page: 10 });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n {data?.posts?.map((post) => (\n

{post.title.rendered}

\n ))}\n
\n );\n};\n")),(0,r.kt)("p",null,"The route will automatically render the latest 10 posts and you get pagination, category, tags and custom taxonomies filtering for free as the following paths will automatically map URL segments into REST API requests:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"/blog/page/2"),(0,r.kt)("li",{parentName:"ul"},"/blog/category/category-name"),(0,r.kt)("li",{parentName:"ul"},"/blog/tag/tag-name"),(0,r.kt)("li",{parentName:"ul"},"/blog/category/category-name/page/2")),(0,r.kt)("h2",{id:"queried-object"},"Queried Object"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," hook exposes a ",(0,r.kt)("inlineCode",{parentName:"p"},"queriedObject"),". It's similar to WordPress ",(0,r.kt)("a",{parentName:"p",href:"https://developer.wordpress.org/reference/functions/get_queried_object/"},"get_queried_object()")," function."),(0,r.kt)("p",null,"It essentially returns what's being queried for, e.g., author or category. If the current page is querying posts within a certain author, then that author object will be populated in ",(0,r.kt)("inlineCode",{parentName:"p"},"data.queriedObject.author"),". Similarly, if the current page is querying posts from a given category ",(0,r.kt)("inlineCode",{parentName:"p"},"data.queriedObject.term")," will be populated with that category."),(0,r.kt)("p",null,"Example: "),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},"// category-name can either come from the URL or be manually specified.\nconst { data } = usePosts({ taxonomy: 'category', category: 'cat-name' });\n\nreturn (\n

Category Page: {data.queriedObject.term.name}

\n);\n")),(0,r.kt)("h2",{id:"category-archive"},"Category Archive"),(0,r.kt)("p",null,"You can use the ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," hook to create a category archive route (",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/category/[...path].js"),")."),(0,r.kt)("admonition",{type:"info"},(0,r.kt)("p",{parentName:"admonition"},"We use ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js")," here because ",(0,r.kt)("strong",{parentName:"p"},"we do not want")," the ",(0,r.kt)("inlineCode",{parentName:"p"},"/category")," route to render anything.")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/category/[...path].js"',title:'"src/pages/category/[...path].js"'},"import {\n usePosts,\n fetchHookData,\n addHookData,\n handleError,\n} from '@headstartwp/next';\n\nconst CategoryPage = () => {\n const { data } = usePosts({ taxonomy: 'category' });\n\n return (\n <>\n

Category Page: {data.queriedObject.term.name}

\n
    \n {data.posts.map((post) => (\n
  • \n {post.title.rendered}\n
    • \n ))}\n
\n \n \n );\n};\n")),(0,r.kt)("h2",{id:"archive-path-matching"},"Archive Path Matching"),(0,r.kt)("p",null,"When using ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts"),' to create archive pages (e.g. a category archive) you can optionally enable "archive path matching" to ensure that your archive routes match the expected permalink dictated by WordPress. Without "archive path matching", your archive routes would match as long as the last segment of the url is a valid term slug. '),(0,r.kt)("p",null,"For instance, let's take the ",(0,r.kt)("inlineCode",{parentName:"p"},"/category/[...path].js")," route above. It will match URLs like:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"/category/cat-name"),(0,r.kt)("li",{parentName:"ul"},"/category/parent-cat-name/cat-name")),(0,r.kt)("p",null,"The framework, however, does not check if ",(0,r.kt)("inlineCode",{parentName:"p"},"parent-cat-name")," is the de facto parent of cat-name, and even worse, it has no way to know (without additional rest api calls) if ",(0,r.kt)("inlineCode",{parentName:"p"},"parent-cat-name")," is even a valid category."),(0,r.kt)("p",null,"To address this, you can pass ",(0,r.kt)("inlineCode",{parentName:"p"},"matchArchivePath")," to ",(0,r.kt)("inlineCode",{parentName:"p"},"usePosts")," to tell the framework to check the ",(0,r.kt)("inlineCode",{parentName:"p"},"link")," property of the ",(0,r.kt)("inlineCode",{parentName:"p"},"queriedObject"),", i.e if the ",(0,r.kt)("inlineCode",{parentName:"p"},"link")," property of ",(0,r.kt)("inlineCode",{parentName:"p"},"cat-name")," returned by the ",(0,r.kt)("a",{parentName:"p",href:"https://developer.wordpress.org/rest-api/reference/categories/#schema"},"WordPress REST API")," matches the front-end path."),(0,r.kt)("p",null,"This setting can also be enabled in ",(0,r.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," globally."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"module.exports = {\n // enable archive path mapping for all default taxonomies\n customTaxonomies: (defaultTaxonomies) => {\n return defaultTaxonomies.map((taxonomy) => ({ ...taxonomy, matchArchivePath: true })),\n },\n}\n")),(0,r.kt)("h2",{id:"known-limitations"},"Known limitations"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"It is not possible to fetch posts from more than one post type.")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/7742af19.5c421f7a.js b/assets/js/7742af19.5cbfb7d6.js similarity index 95% rename from assets/js/7742af19.5c421f7a.js rename to assets/js/7742af19.5cbfb7d6.js index f0b6fa83f..790c176c1 100644 --- a/assets/js/7742af19.5c421f7a.js +++ b/assets/js/7742af19.5cbfb7d6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6494],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),c=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(o.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(o,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[s]="string"==typeof e?e:n,l[1]=p;for(var c=2;c{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>p,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.HeadingBlockProps",title:"Interface: HeadingBlockProps",sidebar_label:"@headstartwp/core.react.HeadingBlockProps",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.react.HeadingBlockProps",id:"interfaces/headstartwp_core.react.HeadingBlockProps",title:"Interface: HeadingBlockProps",description:"@headstartwp/core.react.HeadingBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.HeadingBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.HeadingBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.HeadingBlockProps",title:"Interface: HeadingBlockProps",sidebar_label:"@headstartwp/core.react.HeadingBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.GutenbergBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.GutenbergBlockProps"},next:{title:"@headstartwp/core.react.HookResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.HookResponse"}},o={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"level",id:"level",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".HeadingBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"HeadingBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"level"},"level"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"level"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/HeadingBlock.tsx#L7"},"packages/core/src/react/blocks/HeadingBlock.tsx:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6494],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),c=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(o.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(o,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[s]="string"==typeof e?e:n,l[1]=p;for(var c=2;c{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>p,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.HeadingBlockProps",title:"Interface: HeadingBlockProps",sidebar_label:"@headstartwp/core.react.HeadingBlockProps",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.react.HeadingBlockProps",id:"interfaces/headstartwp_core.react.HeadingBlockProps",title:"Interface: HeadingBlockProps",description:"@headstartwp/core.react.HeadingBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.HeadingBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.HeadingBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.HeadingBlockProps",title:"Interface: HeadingBlockProps",sidebar_label:"@headstartwp/core.react.HeadingBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.GutenbergBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.GutenbergBlockProps"},next:{title:"@headstartwp/core.react.HookResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.HookResponse"}},o={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"level",id:"level",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".HeadingBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"HeadingBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"level"},"level"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"level"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/HeadingBlock.tsx#L7"},"packages/core/src/react/blocks/HeadingBlock.tsx:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/7844975a.11dc4497.js b/assets/js/7844975a.34ff07eb.js similarity index 97% rename from assets/js/7844975a.11dc4497.js rename to assets/js/7844975a.34ff07eb.js index e6c9fdea0..8cf4bbc2b 100644 --- a/assets/js/7844975a.11dc4497.js +++ b/assets/js/7844975a.34ff07eb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4762],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,l[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.IListBlock",title:"Interface: IListBlock",sidebar_label:"@headstartwp/core.react.IListBlock",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.IListBlock",id:"interfaces/headstartwp_core.react.IListBlock",title:"Interface: IListBlock",description:"@headstartwp/core.react.IListBlock",source:"@site/docs/interfaces/headstartwp_core.react.IListBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IListBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IListBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IListBlock",title:"Interface: IListBlock",sidebar_label:"@headstartwp/core.react.IListBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IImageBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IImageBlock"},next:{title:"@headstartwp/core.react.IMediaTextBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IMediaTextBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IListBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ListBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IListBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ListBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ListBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4762],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,l[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.IListBlock",title:"Interface: IListBlock",sidebar_label:"@headstartwp/core.react.IListBlock",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.IListBlock",id:"interfaces/headstartwp_core.react.IListBlock",title:"Interface: IListBlock",description:"@headstartwp/core.react.IListBlock",source:"@site/docs/interfaces/headstartwp_core.react.IListBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IListBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IListBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IListBlock",title:"Interface: IListBlock",sidebar_label:"@headstartwp/core.react.IListBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IImageBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IImageBlock"},next:{title:"@headstartwp/core.react.IMediaTextBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IMediaTextBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IListBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ListBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IListBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ListBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ListBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/7d0dd658.e6138dad.js b/assets/js/7d0dd658.a3098157.js similarity index 86% rename from assets/js/7d0dd658.e6138dad.js rename to assets/js/7d0dd658.a3098157.js index a571a265d..abaec33e2 100644 --- a/assets/js/7d0dd658.e6138dad.js +++ b/assets/js/7d0dd658.a3098157.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7246],{3905:(e,t,a)=>{a.d(t,{Zo:()=>l,kt:()=>m});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function o(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var s=n.createContext({}),d=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},l=function(e){var t=d(e.components);return n.createElement(s.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,l=p(e,["components","mdxType","originalType","parentName"]),c=d(a),u=r,m=c["".concat(s,".").concat(u)]||c[u]||h[u]||i;return a?n.createElement(m,o(o({ref:t},l),{},{components:a})):n.createElement(m,o({ref:t},l))}));function m(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,o=new Array(i);o[0]=u;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[c]="string"==typeof e?e:r,o[1]=p;for(var d=2;d{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>c,frontMatter:()=>i,metadata:()=>p,toc:()=>d});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.TaxonomyEntity",title:"Interface: TaxonomyEntity",sidebar_label:"@headstartwp/core.TaxonomyEntity",custom_edit_url:null},o=void 0,p={unversionedId:"interfaces/headstartwp_core.TaxonomyEntity",id:"interfaces/headstartwp_core.TaxonomyEntity",title:"Interface: TaxonomyEntity",description:"@headstartwp/core.TaxonomyEntity",source:"@site/docs/interfaces/headstartwp_core.TaxonomyEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.TaxonomyEntity",permalink:"/docs/api/interfaces/headstartwp_core.TaxonomyEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.TaxonomyEntity",title:"Interface: TaxonomyEntity",sidebar_label:"@headstartwp/core.TaxonomyEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.TaxonomyArchiveParams",permalink:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},next:{title:"@headstartwp/core.TermEntity",permalink:"/docs/api/interfaces/headstartwp_core.TermEntity"}},s={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"hierarchical",id:"hierarchical",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"rest_base",id:"rest_base",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"types",id:"types",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-7",level:4}],l={toc:d};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},l,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".TaxonomyEntity"),(0,r.kt)("p",null,"Interface for entities from the /wp/v2/taxonomy endpoint."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,r.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"TaxonomyEntity"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"A human-readable description of the taxonomy."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L397"},"packages/core/src/data/types/entities.ts:397")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hierarchical"},"hierarchical"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"hierarchical"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Whether or not the taxonomy should have children."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L402"},"packages/core/src/data/types/entities.ts:402")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The title for the taxonomy."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L407"},"packages/core/src/data/types/entities.ts:407")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"rest_base"},"rest","_","base"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"rest","_","base"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"REST base route for the taxonomy."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L417"},"packages/core/src/data/types/entities.ts:417")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"slug"},"slug"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"An alphanumeric identifier for the taxonomy."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L412"},"packages/core/src/data/types/entities.ts:412")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"types"},"types"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"types"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Types associated with the taxonomy."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L422"},"packages/core/src/data/types/entities.ts:422")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7246],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>m});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function o(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var s=n.createContext({}),l=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},d=function(e){var t=l(e.components);return n.createElement(s.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),c=l(a),u=r,m=c["".concat(s,".").concat(u)]||c[u]||h[u]||i;return a?n.createElement(m,o(o({ref:t},d),{},{components:a})):n.createElement(m,o({ref:t},d))}));function m(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,o=new Array(i);o[0]=u;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[c]="string"==typeof e?e:r,o[1]=p;for(var l=2;l{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>c,frontMatter:()=>i,metadata:()=>p,toc:()=>l});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.TaxonomyEntity",title:"Interface: TaxonomyEntity",sidebar_label:"@headstartwp/core.TaxonomyEntity",custom_edit_url:null},o=void 0,p={unversionedId:"interfaces/headstartwp_core.TaxonomyEntity",id:"interfaces/headstartwp_core.TaxonomyEntity",title:"Interface: TaxonomyEntity",description:"@headstartwp/core.TaxonomyEntity",source:"@site/docs/interfaces/headstartwp_core.TaxonomyEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.TaxonomyEntity",permalink:"/docs/api/interfaces/headstartwp_core.TaxonomyEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.TaxonomyEntity",title:"Interface: TaxonomyEntity",sidebar_label:"@headstartwp/core.TaxonomyEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.TaxonomyArchiveParams",permalink:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams"},next:{title:"@headstartwp/core.TermEntity",permalink:"/docs/api/interfaces/headstartwp_core.TermEntity"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"hierarchical",id:"hierarchical",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"rest_base",id:"rest_base",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"types",id:"types",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:l};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".TaxonomyEntity"),(0,r.kt)("p",null,"Interface for entities from the /wp/v2/taxonomy endpoint."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,r.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"TaxonomyEntity"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"A human-readable description of the taxonomy."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L397"},"packages/core/src/data/types/entities.ts:397")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hierarchical"},"hierarchical"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"hierarchical"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Whether or not the taxonomy should have children."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L402"},"packages/core/src/data/types/entities.ts:402")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The title for the taxonomy."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L407"},"packages/core/src/data/types/entities.ts:407")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"rest_base"},"rest","_","base"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"rest","_","base"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"REST base route for the taxonomy."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L417"},"packages/core/src/data/types/entities.ts:417")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"slug"},"slug"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"An alphanumeric identifier for the taxonomy."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L412"},"packages/core/src/data/types/entities.ts:412")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"types"},"types"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"types"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Types associated with the taxonomy."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L422"},"packages/core/src/data/types/entities.ts:422")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/7d4fdb35.807d37ea.js b/assets/js/7d4fdb35.ba0f7b93.js similarity index 96% rename from assets/js/7d4fdb35.807d37ea.js rename to assets/js/7d4fdb35.ba0f7b93.js index 502f5c80a..5826efa59 100644 --- a/assets/js/7d4fdb35.807d37ea.js +++ b/assets/js/7d4fdb35.ba0f7b93.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8109],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),s=c(r),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return r?a.createElement(h,o(o({ref:t},d),{},{components:r})):a.createElement(h,o({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[s]="string"==typeof e?e:n,o[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.QuoteBlockProps",title:"Interface: QuoteBlockProps",sidebar_label:"@headstartwp/core.react.QuoteBlockProps",custom_edit_url:null},o=void 0,l={unversionedId:"interfaces/headstartwp_core.react.QuoteBlockProps",id:"interfaces/headstartwp_core.react.QuoteBlockProps",title:"Interface: QuoteBlockProps",description:"@headstartwp/core.react.QuoteBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.QuoteBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.QuoteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.QuoteBlockProps",title:"Interface: QuoteBlockProps",sidebar_label:"@headstartwp/core.react.QuoteBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.PullQuoteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps"},next:{title:"@headstartwp/core.react.SafeHtmlProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SafeHtmlProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".QuoteBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"QuoteBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8109],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),s=c(r),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return r?a.createElement(h,o(o({ref:t},d),{},{components:r})):a.createElement(h,o({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=m;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[s]="string"==typeof e?e:n,o[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.QuoteBlockProps",title:"Interface: QuoteBlockProps",sidebar_label:"@headstartwp/core.react.QuoteBlockProps",custom_edit_url:null},o=void 0,l={unversionedId:"interfaces/headstartwp_core.react.QuoteBlockProps",id:"interfaces/headstartwp_core.react.QuoteBlockProps",title:"Interface: QuoteBlockProps",description:"@headstartwp/core.react.QuoteBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.QuoteBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.QuoteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.QuoteBlockProps",title:"Interface: QuoteBlockProps",sidebar_label:"@headstartwp/core.react.QuoteBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.PullQuoteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps"},next:{title:"@headstartwp/core.react.SafeHtmlProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SafeHtmlProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".QuoteBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"QuoteBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/8062ea35.09a1f805.js b/assets/js/8062ea35.b0c6c3f1.js similarity index 98% rename from assets/js/8062ea35.09a1f805.js rename to assets/js/8062ea35.b0c6c3f1.js index d1f3482f6..f6c8e5c0d 100644 --- a/assets/js/8062ea35.09a1f805.js +++ b/assets/js/8062ea35.b0c6c3f1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7253],{3905:(e,t,n)=>{n.d(t,{Zo:()=>k,kt:()=>u});var r=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var o=r.createContext({}),p=function(e){var t=r.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},k=function(e){var t=p(e.components);return r.createElement(o.Provider,{value:t},e.children)},s="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,o=e.parentName,k=d(e,["components","mdxType","originalType","parentName"]),s=p(n),m=i,u=s["".concat(o,".").concat(m)]||s[m]||c[m]||a;return n?r.createElement(u,l(l({ref:t},k),{},{components:n})):r.createElement(u,l({ref:t},k))}));function u(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,l=new Array(a);l[0]=m;var d={};for(var o in t)hasOwnProperty.call(t,o)&&(d[o]=t[o]);d.originalType=e,d[s]="string"==typeof e?e:i,l[1]=d;for(var p=2;p{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>s,frontMatter:()=>a,metadata:()=>d,toc:()=>p});var r=n(7462),i=(n(7294),n(3905));const a={id:"headstartwp_next.LinkBlockProps",title:"Interface: LinkBlockProps",sidebar_label:"@headstartwp/next.LinkBlockProps",custom_edit_url:null},l=void 0,d={unversionedId:"interfaces/headstartwp_next.LinkBlockProps",id:"interfaces/headstartwp_next.LinkBlockProps",title:"Interface: LinkBlockProps",description:"@headstartwp/next.LinkBlockProps",source:"@site/docs/interfaces/headstartwp_next.LinkBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_next.LinkBlockProps",permalink:"/docs/api/interfaces/headstartwp_next.LinkBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_next.LinkBlockProps",title:"Interface: LinkBlockProps",sidebar_label:"@headstartwp/next.LinkBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/next.ImageProps",permalink:"/docs/api/interfaces/headstartwp_next.ImageProps"}},o={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"href",id:"href",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"rel",id:"rel",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4}],k={toc:p};function s(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},k,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next"},"@headstartwp/next"),".LinkBlockProps"),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("inlineCode",{parentName:"p"},"IBlockAttributes")),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"LinkBlockProps"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"attributes"},"attributes"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"attributes"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"align")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Align"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"border")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Border"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"colors")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Colors"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"spacing")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Spacing"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"typography")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Typography"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"width?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,"IBlockAttributes.attributes"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:70"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"children"},"children"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"children"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,"IBlockAttributes.children"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:69"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"classname"},"className"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"className"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,"IBlockAttributes.className"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:65"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"domnode"},"domNode"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"domNode"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Element")),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,"IBlockAttributes.domNode"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:67"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"href"},"href"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"href"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/blocks/LinkBlock.tsx#L7"},"packages/next/src/blocks/LinkBlock.tsx:7")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,"IBlockAttributes.htmlAnchor"),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:68"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"name"},"name"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"name"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,"IBlockAttributes.name"),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:64"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"rel"},"rel"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"rel"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/blocks/LinkBlock.tsx#L8"},"packages/next/src/blocks/LinkBlock.tsx:8")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"style"},"style"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"style"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,"IBlockAttributes.style"),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:66"))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7253],{3905:(e,t,n)=>{n.d(t,{Zo:()=>k,kt:()=>u});var r=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var o=r.createContext({}),p=function(e){var t=r.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},k=function(e){var t=p(e.components);return r.createElement(o.Provider,{value:t},e.children)},s="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,o=e.parentName,k=d(e,["components","mdxType","originalType","parentName"]),s=p(n),m=i,u=s["".concat(o,".").concat(m)]||s[m]||c[m]||a;return n?r.createElement(u,l(l({ref:t},k),{},{components:n})):r.createElement(u,l({ref:t},k))}));function u(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,l=new Array(a);l[0]=m;var d={};for(var o in t)hasOwnProperty.call(t,o)&&(d[o]=t[o]);d.originalType=e,d[s]="string"==typeof e?e:i,l[1]=d;for(var p=2;p{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>s,frontMatter:()=>a,metadata:()=>d,toc:()=>p});var r=n(7462),i=(n(7294),n(3905));const a={id:"headstartwp_next.LinkBlockProps",title:"Interface: LinkBlockProps",sidebar_label:"@headstartwp/next.LinkBlockProps",custom_edit_url:null},l=void 0,d={unversionedId:"interfaces/headstartwp_next.LinkBlockProps",id:"interfaces/headstartwp_next.LinkBlockProps",title:"Interface: LinkBlockProps",description:"@headstartwp/next.LinkBlockProps",source:"@site/docs/interfaces/headstartwp_next.LinkBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_next.LinkBlockProps",permalink:"/docs/api/interfaces/headstartwp_next.LinkBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_next.LinkBlockProps",title:"Interface: LinkBlockProps",sidebar_label:"@headstartwp/next.LinkBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/next.ImageProps",permalink:"/docs/api/interfaces/headstartwp_next.ImageProps"}},o={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"href",id:"href",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"rel",id:"rel",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4}],k={toc:p};function s(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,r.Z)({},k,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next"},"@headstartwp/next"),".LinkBlockProps"),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("inlineCode",{parentName:"p"},"IBlockAttributes")),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"LinkBlockProps"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"attributes"},"attributes"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"attributes"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"align")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Align"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"border")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Border"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"colors")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Colors"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"spacing")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Spacing"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"typography")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"Typography"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"width?")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"string"))))),(0,i.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,i.kt)("p",null,"IBlockAttributes.attributes"),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:70"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"children"},"children"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"children"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,i.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,i.kt)("p",null,"IBlockAttributes.children"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:69"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"classname"},"className"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"className"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,i.kt)("p",null,"IBlockAttributes.className"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:65"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"domnode"},"domNode"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"domNode"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Element")),(0,i.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,i.kt)("p",null,"IBlockAttributes.domNode"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:67"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"href"},"href"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"href"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/blocks/LinkBlock.tsx#L7"},"packages/next/src/blocks/LinkBlock.tsx:7")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,i.kt)("p",null,"IBlockAttributes.htmlAnchor"),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:68"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"name"},"name"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"name"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,i.kt)("p",null,"IBlockAttributes.name"),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:64"),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"rel"},"rel"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"rel"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/blocks/LinkBlock.tsx#L8"},"packages/next/src/blocks/LinkBlock.tsx:8")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"style"},"style"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"style"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,i.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,i.kt)("p",null,"IBlockAttributes.style"),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,"packages/core/dist/mjs/react/blocks/types.d.ts:66"))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/82691c56.c0d561c9.js b/assets/js/82691c56.78c79f91.js similarity index 98% rename from assets/js/82691c56.c0d561c9.js rename to assets/js/82691c56.78c79f91.js index d60eb9934..0c50dd70a 100644 --- a/assets/js/82691c56.c0d561c9.js +++ b/assets/js/82691c56.78c79f91.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3641],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>m});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var l=a.createContext({}),c=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},p=function(e){var t=c(e.components);return a.createElement(l.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=c(n),h=r,m=u["".concat(l,".").concat(h)]||u[h]||d[h]||o;return n?a.createElement(m,i(i({ref:t},p),{},{components:n})):a.createElement(m,i({ref:t},p))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,i=new Array(o);i[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[u]="string"==typeof e?e:r,i[1]=s;for(var c=2;c{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>c});var a=n(7462),r=(n(7294),n(3905));const o={slug:"/data-fetching",sidebar_label:"Introduction",sidebar_position:0},i="Introduction",s={unversionedId:"Data Fetching/introduction",id:"Data Fetching/introduction",title:"Introduction",description:'HeadstartWP exposes several customs react hooks that provide a seamless data-fetching experience with WordPress. Those hooks are built to be "isomorphic" i.e can be executed either on the browser or on the server (e.g: Node.js).',source:"@site/documentation/02 - Data Fetching/introduction.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching",permalink:"/docs/learn/data-fetching",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/introduction.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",sidebarPosition:0,frontMatter:{slug:"/data-fetching",sidebar_label:"Introduction",sidebar_position:0},sidebar:"tutorialSidebar",previous:{title:"Quick Introduction to the Framework",permalink:"/docs/learn/getting-started/quick-tutorial"},next:{title:"The usePost hook",permalink:"/docs/learn/data-fetching/usepost"}},l={},c=[{value:"React Custom hooks",id:"react-custom-hooks",level:2},{value:"Next.js "bindings"",id:"nextjs-bindings",level:2}],p={toc:c};function u(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"introduction"},"Introduction"),(0,r.kt)("p",null,'HeadstartWP exposes several customs react hooks that provide a seamless data-fetching experience with WordPress. Those hooks are built to be "isomorphic" i.e can be executed either on the browser or on the server (e.g: Node.js).'),(0,r.kt)("p",null,"The data-fetching logic itself is abstracted by ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/headstartwp_core.AbstractFetchStrategy/"},"strategies"),". The custom React hooks are powered by ",(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app/"},"useSwr"),"."),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},"With Next.js ",(0,r.kt)("inlineCode",{parentName:"p"},"app")," directory support added in Next.js 13, we will be providing special hooks that will work well with Suspense and Streaming. At the moment, we do not recommend using the existing custom hooks in the ",(0,r.kt)("inlineCode",{parentName:"p"},"app")," directory.")),(0,r.kt)("h2",{id:"react-custom-hooks"},"React Custom hooks"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/core/react")," package export exposes the react hooks implementation on top of the ",(0,r.kt)("inlineCode",{parentName:"p"},"useSwr")," library. Those hooks are called ",(0,r.kt)("inlineCode",{parentName:"p"},"useFetch*")," e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"useFetchPost"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"useFetchPosts")," and so on. They can be used outside of Next.js (i.e create-react-app, React Native etc.)."),(0,r.kt)("h2",{id:"nextjs-bindings"},'Next.js "bindings"'),(0,r.kt)("p",null,"Next.js is the main meta-framework supported by HeadstartWP, therefore we provide special bindings that make using the framework a breeze."),(0,r.kt)("p",null,"The Next.js bindings are exposed by the ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/next")," package."),(0,r.kt)("p",null,'The main difference is that the Next.js binding will automatically extract URL segments into request params (i.e extracting post name from the URL automatically) when used in conjunction with the "path" catch-all pattern like ',(0,r.kt)("inlineCode",{parentName:"p"},"src/page/[...path.js]"),"."),(0,r.kt)("p",null,"The following example uses the ",(0,r.kt)("inlineCode",{parentName:"p"},"useFetchPost")," to manually fetch a page with the ",(0,r.kt)("inlineCode",{parentName:"p"},"about")," slug."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"import { useFetchPost } from '@headstartwp/core/react';\n\nconst Page = () => {\n const { data: { post }, loading } = useFetchPost({ slug: 'about', post_type: 'page' });\n\n if (loading) {\n return 'Loading...';\n }\n\n return (

{post.title.rendered}

);\n};\n")),(0,r.kt)("p",null,"You could omit the ",(0,r.kt)("inlineCode",{parentName:"p"},"slug")," param by specifying the current path of the page and it will parse the path and extract matched params following the WordPress pretty permalinks convention."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"usePost({ post_type: 'page' }, {}, '/about');\n")),(0,r.kt)("p",null,"By using the Next.js bindings and following the path catch-all route convention, the URL extraction is automatic."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/[...path].js"',title:'"src/pages/[...path].js"'},"import { usePost } from '@headstartwp/next';\n\nconst Page = () => {\n // slug is automatically injected from the next.js router\n // if you pass a slug it will override what's coming from the URL\n const { loading, error, data } = usePost({ post_type: 'page' });\n\n if (loading) {\n return 'Loading...';\n }\n\n\n return (

{post.title.rendered}

);\n};\n")),(0,r.kt)("p",null,"Then visiting a URL like ",(0,r.kt)("inlineCode",{parentName:"p"},"/about")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"/privacy-policy")," will render the contents of the about and privacy policy pages respectively."),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},'The remaining of this section will assume the Next.js versions of the hooks are used. It will also assume the "path" catch-all route conventions are being used.')))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3641],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>m});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var l=a.createContext({}),c=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},p=function(e){var t=c(e.components);return a.createElement(l.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=c(n),h=r,m=u["".concat(l,".").concat(h)]||u[h]||d[h]||o;return n?a.createElement(m,i(i({ref:t},p),{},{components:n})):a.createElement(m,i({ref:t},p))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,i=new Array(o);i[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[u]="string"==typeof e?e:r,i[1]=s;for(var c=2;c{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>c});var a=n(7462),r=(n(7294),n(3905));const o={slug:"/data-fetching",sidebar_label:"Introduction",sidebar_position:0},i="Introduction",s={unversionedId:"Data Fetching/introduction",id:"Data Fetching/introduction",title:"Introduction",description:'HeadstartWP exposes several customs react hooks that provide a seamless data-fetching experience with WordPress. Those hooks are built to be "isomorphic" i.e can be executed either on the browser or on the server (e.g: Node.js).',source:"@site/documentation/02 - Data Fetching/introduction.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching",permalink:"/docs/learn/data-fetching",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/introduction.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",sidebarPosition:0,frontMatter:{slug:"/data-fetching",sidebar_label:"Introduction",sidebar_position:0},sidebar:"tutorialSidebar",previous:{title:"Quick Introduction to the Framework",permalink:"/docs/learn/getting-started/quick-tutorial"},next:{title:"The usePost hook",permalink:"/docs/learn/data-fetching/usepost"}},l={},c=[{value:"React Custom hooks",id:"react-custom-hooks",level:2},{value:"Next.js "bindings"",id:"nextjs-bindings",level:2}],p={toc:c};function u(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"introduction"},"Introduction"),(0,r.kt)("p",null,'HeadstartWP exposes several customs react hooks that provide a seamless data-fetching experience with WordPress. Those hooks are built to be "isomorphic" i.e can be executed either on the browser or on the server (e.g: Node.js).'),(0,r.kt)("p",null,"The data-fetching logic itself is abstracted by ",(0,r.kt)("a",{parentName:"p",href:"/api/classes/headstartwp_core.AbstractFetchStrategy/"},"strategies"),". The custom React hooks are powered by ",(0,r.kt)("a",{parentName:"p",href:"https://swr.vercel.app/"},"useSwr"),"."),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},"With Next.js ",(0,r.kt)("inlineCode",{parentName:"p"},"app")," directory support added in Next.js 13, we will be providing special hooks that will work well with Suspense and Streaming. At the moment, we do not recommend using the existing custom hooks in the ",(0,r.kt)("inlineCode",{parentName:"p"},"app")," directory.")),(0,r.kt)("h2",{id:"react-custom-hooks"},"React Custom hooks"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/core/react")," package export exposes the react hooks implementation on top of the ",(0,r.kt)("inlineCode",{parentName:"p"},"useSwr")," library. Those hooks are called ",(0,r.kt)("inlineCode",{parentName:"p"},"useFetch*")," e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"useFetchPost"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"useFetchPosts")," and so on. They can be used outside of Next.js (i.e create-react-app, React Native etc.)."),(0,r.kt)("h2",{id:"nextjs-bindings"},'Next.js "bindings"'),(0,r.kt)("p",null,"Next.js is the main meta-framework supported by HeadstartWP, therefore we provide special bindings that make using the framework a breeze."),(0,r.kt)("p",null,"The Next.js bindings are exposed by the ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/next")," package."),(0,r.kt)("p",null,'The main difference is that the Next.js binding will automatically extract URL segments into request params (i.e extracting post name from the URL automatically) when used in conjunction with the "path" catch-all pattern like ',(0,r.kt)("inlineCode",{parentName:"p"},"src/page/[...path.js]"),"."),(0,r.kt)("p",null,"The following example uses the ",(0,r.kt)("inlineCode",{parentName:"p"},"useFetchPost")," to manually fetch a page with the ",(0,r.kt)("inlineCode",{parentName:"p"},"about")," slug."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"import { useFetchPost } from '@headstartwp/core/react';\n\nconst Page = () => {\n const { data: { post }, loading } = useFetchPost({ slug: 'about', post_type: 'page' });\n\n if (loading) {\n return 'Loading...';\n }\n\n return (

{post.title.rendered}

);\n};\n")),(0,r.kt)("p",null,"You could omit the ",(0,r.kt)("inlineCode",{parentName:"p"},"slug")," param by specifying the current path of the page and it will parse the path and extract matched params following the WordPress pretty permalinks convention."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"usePost({ post_type: 'page' }, {}, '/about');\n")),(0,r.kt)("p",null,"By using the Next.js bindings and following the path catch-all route convention, the URL extraction is automatic."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/[...path].js"',title:'"src/pages/[...path].js"'},"import { usePost } from '@headstartwp/next';\n\nconst Page = () => {\n // slug is automatically injected from the next.js router\n // if you pass a slug it will override what's coming from the URL\n const { loading, error, data } = usePost({ post_type: 'page' });\n\n if (loading) {\n return 'Loading...';\n }\n\n\n return (

{post.title.rendered}

);\n};\n")),(0,r.kt)("p",null,"Then visiting a URL like ",(0,r.kt)("inlineCode",{parentName:"p"},"/about")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"/privacy-policy")," will render the contents of the about and privacy policy pages respectively."),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},'The remaining of this section will assume the Next.js versions of the hooks are used. It will also assume the "path" catch-all route conventions are being used.')))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/829b8700.8f602b1d.js b/assets/js/829b8700.c053ef0a.js similarity index 97% rename from assets/js/829b8700.8f602b1d.js rename to assets/js/829b8700.c053ef0a.js index 4ff70496c..c46a22f82 100644 --- a/assets/js/829b8700.8f602b1d.js +++ b/assets/js/829b8700.c053ef0a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2570],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||o;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,l=new Array(o);l[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:n,l[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.ICoverBlock",title:"Interface: ICoverBlock",sidebar_label:"@headstartwp/core.react.ICoverBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.ICoverBlock",id:"interfaces/headstartwp_core.react.ICoverBlock",title:"Interface: ICoverBlock",description:"@headstartwp/core.react.ICoverBlock",source:"@site/docs/interfaces/headstartwp_core.react.ICoverBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ICoverBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ICoverBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ICoverBlock",title:"Interface: ICoverBlock",sidebar_label:"@headstartwp/core.react.ICoverBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IColumnsBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IColumnsBlock"},next:{title:"@headstartwp/core.react.IDataWPBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IDataWPBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ICoverBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CoverBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ICoverBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CoverBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CoverBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2570],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||o;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,l=new Array(o);l[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:n,l[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.ICoverBlock",title:"Interface: ICoverBlock",sidebar_label:"@headstartwp/core.react.ICoverBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.ICoverBlock",id:"interfaces/headstartwp_core.react.ICoverBlock",title:"Interface: ICoverBlock",description:"@headstartwp/core.react.ICoverBlock",source:"@site/docs/interfaces/headstartwp_core.react.ICoverBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ICoverBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ICoverBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ICoverBlock",title:"Interface: ICoverBlock",sidebar_label:"@headstartwp/core.react.ICoverBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IColumnsBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IColumnsBlock"},next:{title:"@headstartwp/core.react.IDataWPBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IDataWPBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ICoverBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CoverBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ICoverBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CoverBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"CoverBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/84bf0742.da4885f3.js b/assets/js/84bf0742.c4825db7.js similarity index 97% rename from assets/js/84bf0742.da4885f3.js rename to assets/js/84bf0742.c4825db7.js index 673abf843..37badd684 100644 --- a/assets/js/84bf0742.da4885f3.js +++ b/assets/js/84bf0742.c4825db7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5145],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>u});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function l(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=n.createContext({}),s=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},c=function(e){var t=s(e.components);return n.createElement(p.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,l=e.originalType,p=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),d=s(r),m=a,u=d["".concat(p,".").concat(m)]||d[m]||k[m]||l;return r?n.createElement(u,o(o({ref:t},c),{},{components:r})):n.createElement(u,o({ref:t},c))}));function u(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=r.length,o=new Array(l);o[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[d]="string"==typeof e?e:a,o[1]=i;for(var s=2;s{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>d,frontMatter:()=>l,metadata:()=>i,toc:()=>s});var n=r(7462),a=(r(7294),r(3905));const l={id:"headstartwp_core.react.BlockRendererProps",title:"Interface: BlockRendererProps",sidebar_label:"@headstartwp/core.react.BlockRendererProps",custom_edit_url:null},o=void 0,i={unversionedId:"interfaces/headstartwp_core.react.BlockRendererProps",id:"interfaces/headstartwp_core.react.BlockRendererProps",title:"Interface: BlockRendererProps",description:"@headstartwp/core.react.BlockRendererProps",source:"@site/docs/interfaces/headstartwp_core.react.BlockRendererProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.BlockRendererProps",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockRendererProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.BlockRendererProps",title:"Interface: BlockRendererProps",sidebar_label:"@headstartwp/core.react.BlockRendererProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.BlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockProps"},next:{title:"@headstartwp/core.react.ButtonBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps"}},p={},s=[{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"html",id:"html",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"ksesAllowList",id:"ksesallowlist",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"sanitizeFn",id:"sanitizefn",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-3",level:4}],c={toc:s};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".BlockRendererProps"),(0,a.kt)("p",null,"The type definition for the ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#blocksrenderer"},"BlocksRenderer")," component."),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"children"},"children"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"children"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,a.kt)("p",null,"The children components that must implements ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.BlockProps"},"BlockProps"),". Failing to implement ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.BlockProps"},"BlockProps"),"\nwill issue a warning at runtime."),(0,a.kt)("p",null,"Passing children are not mandatory, if you do not pass them ",(0,a.kt)("inlineCode",{parentName:"p"},"BlocksRenderer")," will simply sanitize the html markup."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L110"},"packages/core/src/react/components/BlocksRenderer.tsx:110")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"html"},"html"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"html"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The HTML string to be parsed."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-jsx"},',\n')),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L83"},"packages/core/src/react/components/BlocksRenderer.tsx:83")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"ksesallowlist"},"ksesAllowList"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"ksesAllowList"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"IWhiteList")),(0,a.kt)("p",null,"The allow list for the parser"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-jsx"},',\n')),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L95"},"packages/core/src/react/components/BlocksRenderer.tsx:95")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"sanitizefn"},"sanitizeFn"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"sanitizeFn"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"html"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"ksesAllowList?"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"IWhiteList"),") => ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"html"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"ksesAllowList?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"A custom implementation of the sanitize function."),(0,a.kt)("p",null,"If none is provided it's going to default to ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#wpksespost"},"wpKsesPost")),(0,a.kt)("h5",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"html")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"ksesAllowList?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"IWhiteList"))))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L102"},"packages/core/src/react/components/BlocksRenderer.tsx:102")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5145],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>u});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function l(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=n.createContext({}),s=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},c=function(e){var t=s(e.components);return n.createElement(p.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,l=e.originalType,p=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),d=s(r),m=a,u=d["".concat(p,".").concat(m)]||d[m]||k[m]||l;return r?n.createElement(u,o(o({ref:t},c),{},{components:r})):n.createElement(u,o({ref:t},c))}));function u(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=r.length,o=new Array(l);o[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[d]="string"==typeof e?e:a,o[1]=i;for(var s=2;s{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>d,frontMatter:()=>l,metadata:()=>i,toc:()=>s});var n=r(7462),a=(r(7294),r(3905));const l={id:"headstartwp_core.react.BlockRendererProps",title:"Interface: BlockRendererProps",sidebar_label:"@headstartwp/core.react.BlockRendererProps",custom_edit_url:null},o=void 0,i={unversionedId:"interfaces/headstartwp_core.react.BlockRendererProps",id:"interfaces/headstartwp_core.react.BlockRendererProps",title:"Interface: BlockRendererProps",description:"@headstartwp/core.react.BlockRendererProps",source:"@site/docs/interfaces/headstartwp_core.react.BlockRendererProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.BlockRendererProps",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockRendererProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.BlockRendererProps",title:"Interface: BlockRendererProps",sidebar_label:"@headstartwp/core.react.BlockRendererProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.BlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockProps"},next:{title:"@headstartwp/core.react.ButtonBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps"}},p={},s=[{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"html",id:"html",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"ksesAllowList",id:"ksesallowlist",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"sanitizeFn",id:"sanitizefn",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-3",level:4}],c={toc:s};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".BlockRendererProps"),(0,a.kt)("p",null,"The type definition for the ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#blocksrenderer"},"BlocksRenderer")," component."),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"children"},"children"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"children"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,a.kt)("p",null,"The children components that must implements ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.BlockProps"},"BlockProps"),". Failing to implement ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.BlockProps"},"BlockProps"),"\nwill issue a warning at runtime."),(0,a.kt)("p",null,"Passing children are not mandatory, if you do not pass them ",(0,a.kt)("inlineCode",{parentName:"p"},"BlocksRenderer")," will simply sanitize the html markup."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L110"},"packages/core/src/react/components/BlocksRenderer.tsx:110")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"html"},"html"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"html"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"The HTML string to be parsed."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-jsx"},',\n')),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L83"},"packages/core/src/react/components/BlocksRenderer.tsx:83")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"ksesallowlist"},"ksesAllowList"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"ksesAllowList"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"IWhiteList")),(0,a.kt)("p",null,"The allow list for the parser"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-jsx"},',\n')),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L95"},"packages/core/src/react/components/BlocksRenderer.tsx:95")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"sanitizefn"},"sanitizeFn"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"sanitizeFn"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"html"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"ksesAllowList?"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"IWhiteList"),") => ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"html"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"ksesAllowList?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"A custom implementation of the sanitize function."),(0,a.kt)("p",null,"If none is provided it's going to default to ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#wpksespost"},"wpKsesPost")),(0,a.kt)("h5",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"html")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"ksesAllowList?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"IWhiteList"))))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L102"},"packages/core/src/react/components/BlocksRenderer.tsx:102")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/8872dee1.37d6dfda.js b/assets/js/8872dee1.37d6dfda.js deleted file mode 100644 index 0c37eb6a8..000000000 --- a/assets/js/8872dee1.37d6dfda.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9638],{3905:(e,t,n)=>{n.d(t,{Zo:()=>l,kt:()=>f});var r=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var c=r.createContext({}),u=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},l=function(e){var t=u(e.components);return r.createElement(c.Provider,{value:t},e.children)},p="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,a=e.originalType,c=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),p=u(n),h=o,f=p["".concat(c,".").concat(h)]||p[h]||d[h]||a;return n?r.createElement(f,i(i({ref:t},l),{},{components:n})):r.createElement(f,i({ref:t},l))}));function f(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=n.length,i=new Array(a);i[0]=h;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s[p]="string"==typeof e?e:o,i[1]=s;for(var u=2;u{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>p,frontMatter:()=>a,metadata:()=>s,toc:()=>u});var r=n(7462),o=(n(7294),n(3905));const a={slug:"/data-fetching/useSeo",sidebar_position:7},i="The useSeo hook",s={unversionedId:"Data Fetching/useSeo",id:"Data Fetching/useSeo",title:"The useSeo hook",description:"This hook was introduced in @headstartwp/next@1.1.0",source:"@site/documentation/02 - Data Fetching/useSeo.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/useSeo",permalink:"/docs/learn/data-fetching/useSeo",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/useSeo.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",sidebarPosition:7,frontMatter:{slug:"/data-fetching/useSeo",sidebar_position:7},sidebar:"tutorialSidebar",previous:{title:"The useSearchNative hook",permalink:"/docs/learn/data-fetching/usesearch-native"},next:{title:"Creating your own custom hooks",permalink:"/docs/learn/data-fetching/creating-your-own-custom-hooks"}},c={},u=[{value:"Basic Usage",id:"basic-usage",level:2}],l={toc:u};function p(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},l,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"the-useseo-hook"},"The useSeo hook"),(0,o.kt)("admonition",{type:"info"},(0,o.kt)("p",{parentName:"admonition"},"This hook was introduced in ",(0,o.kt)("inlineCode",{parentName:"p"},"@headstartwp/next@1.1.0"))),(0,o.kt)("p",null,"The ",(0,o.kt)("inlineCode",{parentName:"p"},"useSeo")," hook returns the SEO data for the current page."),(0,o.kt)("h2",{id:"basic-usage"},"Basic Usage"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-javascript"},"// by default it returns the json object\nconst yoast_json = useSeo();\nconst yoast_json = useSeo('json');\n// but you can also get the plain html markup for the metadata\nconst yoast_head = useSeo('html');\n")),(0,o.kt)("p",null,"If there's no seo information for the current route, this hook will return ",(0,o.kt)("inlineCode",{parentName:"p"},"null")," therefore we recommend checking for null before using the return value."))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/8872dee1.65c90b17.js b/assets/js/8872dee1.65c90b17.js new file mode 100644 index 000000000..93b417083 --- /dev/null +++ b/assets/js/8872dee1.65c90b17.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9638],{3905:(e,t,n)=>{n.d(t,{Zo:()=>l,kt:()=>f});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var c=r.createContext({}),u=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},l=function(e){var t=u(e.components);return r.createElement(c.Provider,{value:t},e.children)},p="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,c=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),p=u(n),h=a,f=p["".concat(c,".").concat(h)]||p[h]||d[h]||o;return n?r.createElement(f,i(i({ref:t},l),{},{components:n})):r.createElement(f,i({ref:t},l))}));function f(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,i=new Array(o);i[0]=h;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s[p]="string"==typeof e?e:a,i[1]=s;for(var u=2;u{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>s,toc:()=>u});var r=n(7462),a=(n(7294),n(3905));const o={slug:"/data-fetching/useSeo",sidebar_position:7},i="The useSeo hook",s={unversionedId:"Data Fetching/useSeo",id:"Data Fetching/useSeo",title:"The useSeo hook",description:"This hook was introduced in @headstartwp/next@1.1.0",source:"@site/documentation/02 - Data Fetching/useSeo.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/useSeo",permalink:"/docs/learn/data-fetching/useSeo",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/useSeo.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",sidebarPosition:7,frontMatter:{slug:"/data-fetching/useSeo",sidebar_position:7},sidebar:"tutorialSidebar",previous:{title:"The useSearchNative hook",permalink:"/docs/learn/data-fetching/usesearch-native"},next:{title:"Mutating Data",permalink:"/docs/learn/data-fetching/mutating"}},c={},u=[{value:"Basic Usage",id:"basic-usage",level:2}],l={toc:u};function p(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},l,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"the-useseo-hook"},"The useSeo hook"),(0,a.kt)("admonition",{type:"info"},(0,a.kt)("p",{parentName:"admonition"},"This hook was introduced in ",(0,a.kt)("inlineCode",{parentName:"p"},"@headstartwp/next@1.1.0"))),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"useSeo")," hook returns the SEO data for the current page."),(0,a.kt)("h2",{id:"basic-usage"},"Basic Usage"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"// by default it returns the json object\nconst yoast_json = useSeo();\nconst yoast_json = useSeo('json');\n// but you can also get the plain html markup for the metadata\nconst yoast_head = useSeo('html');\n")),(0,a.kt)("p",null,"If there's no seo information for the current route, this hook will return ",(0,a.kt)("inlineCode",{parentName:"p"},"null")," therefore we recommend checking for null before using the return value."))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/88a75f53.35f3f7dd.js b/assets/js/88a75f53.26318ff9.js similarity index 94% rename from assets/js/88a75f53.35f3f7dd.js rename to assets/js/88a75f53.26318ff9.js index db4e202dd..b06494963 100644 --- a/assets/js/88a75f53.35f3f7dd.js +++ b/assets/js/88a75f53.26318ff9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1272],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var l=n.createContext({}),d=function(e){var t=n.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=d(e.components);return n.createElement(l.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,l=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),c=d(a),h=r,k=c["".concat(l,".").concat(h)]||c[h]||u[h]||i;return a?n.createElement(k,p(p({ref:t},o),{},{components:a})):n.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,p=new Array(i);p[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[c]="string"==typeof e?e:r,p[1]=s;for(var d=2;d{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.AuthorEntity",title:"Interface: AuthorEntity",sidebar_label:"@headstartwp/core.AuthorEntity",custom_edit_url:null},p=void 0,s={unversionedId:"interfaces/headstartwp_core.AuthorEntity",id:"interfaces/headstartwp_core.AuthorEntity",title:"Interface: AuthorEntity",description:"@headstartwp/core.AuthorEntity",source:"@site/docs/interfaces/headstartwp_core.AuthorEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.AuthorEntity",permalink:"/docs/api/interfaces/headstartwp_core.AuthorEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.AuthorEntity",title:"Interface: AuthorEntity",sidebar_label:"@headstartwp/core.AuthorEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.AttachmentEntity",permalink:"/docs/api/interfaces/headstartwp_core.AttachmentEntity"},next:{title:"@headstartwp/core.AvatarUrls",permalink:"/docs/api/interfaces/headstartwp_core.AvatarUrls"}},l={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"avatar_urls",id:"avatar_urls",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"link",id:"link",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"meta",id:"meta",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-9",level:4}],o={toc:d};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".AuthorEntity"),(0,r.kt)("p",null,"Interface for entities from the /wp/v2/users endpoint."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,r.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"AuthorEntity"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"avatar_urls"},"avatar","_","urls"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"avatar","_","urls"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AvatarUrls"},(0,r.kt)("inlineCode",{parentName:"a"},"AvatarUrls"))),(0,r.kt)("p",null,"Avatar URLs for the user."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L540"},"packages/core/src/data/types/entities.ts:540")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Description of the user."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L525"},"packages/core/src/data/types/entities.ts:525")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"id"},"id"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Unique identifier for the user."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L510"},"packages/core/src/data/types/entities.ts:510")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"link"},"link"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"link"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Author URL of the user."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L530"},"packages/core/src/data/types/entities.ts:530")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"meta"},"meta"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,r.kt)("p",null,"Meta fields."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L545"},"packages/core/src/data/types/entities.ts:545")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Display name for the user."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L515"},"packages/core/src/data/types/entities.ts:515")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"slug"},"slug"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"An alphanumeric identifier for the user."),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L535"},"packages/core/src/data/types/entities.ts:535")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"url"},"url"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"url"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"URL of the user."),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L520"},"packages/core/src/data/types/entities.ts:520")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L548"},"packages/core/src/data/types/entities.ts:548")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L547"},"packages/core/src/data/types/entities.ts:547")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1272],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var l=n.createContext({}),d=function(e){var t=n.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=d(e.components);return n.createElement(l.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,l=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),c=d(a),h=r,k=c["".concat(l,".").concat(h)]||c[h]||u[h]||i;return a?n.createElement(k,p(p({ref:t},o),{},{components:a})):n.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,p=new Array(i);p[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[c]="string"==typeof e?e:r,p[1]=s;for(var d=2;d{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.AuthorEntity",title:"Interface: AuthorEntity",sidebar_label:"@headstartwp/core.AuthorEntity",custom_edit_url:null},p=void 0,s={unversionedId:"interfaces/headstartwp_core.AuthorEntity",id:"interfaces/headstartwp_core.AuthorEntity",title:"Interface: AuthorEntity",description:"@headstartwp/core.AuthorEntity",source:"@site/docs/interfaces/headstartwp_core.AuthorEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.AuthorEntity",permalink:"/docs/api/interfaces/headstartwp_core.AuthorEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.AuthorEntity",title:"Interface: AuthorEntity",sidebar_label:"@headstartwp/core.AuthorEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.AttachmentEntity",permalink:"/docs/api/interfaces/headstartwp_core.AttachmentEntity"},next:{title:"@headstartwp/core.AvatarUrls",permalink:"/docs/api/interfaces/headstartwp_core.AvatarUrls"}},l={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"avatar_urls",id:"avatar_urls",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"link",id:"link",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"meta",id:"meta",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-9",level:4}],o={toc:d};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".AuthorEntity"),(0,r.kt)("p",null,"Interface for entities from the /wp/v2/users endpoint."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,r.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"AuthorEntity"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"avatar_urls"},"avatar","_","urls"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"avatar","_","urls"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AvatarUrls"},(0,r.kt)("inlineCode",{parentName:"a"},"AvatarUrls"))),(0,r.kt)("p",null,"Avatar URLs for the user."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L540"},"packages/core/src/data/types/entities.ts:540")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Description of the user."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L525"},"packages/core/src/data/types/entities.ts:525")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"id"},"id"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Unique identifier for the user."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L510"},"packages/core/src/data/types/entities.ts:510")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"link"},"link"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"link"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Author URL of the user."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L530"},"packages/core/src/data/types/entities.ts:530")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"meta"},"meta"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,r.kt)("p",null,"Meta fields."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L545"},"packages/core/src/data/types/entities.ts:545")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Display name for the user."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L515"},"packages/core/src/data/types/entities.ts:515")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"slug"},"slug"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"An alphanumeric identifier for the user."),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L535"},"packages/core/src/data/types/entities.ts:535")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"url"},"url"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"url"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"URL of the user."),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L520"},"packages/core/src/data/types/entities.ts:520")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"overrides"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L548"},"packages/core/src/data/types/entities.ts:548")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"overrides-1"},"Overrides"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L547"},"packages/core/src/data/types/entities.ts:547")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/90fd0dd1.7e6601a2.js b/assets/js/90fd0dd1.f192b877.js similarity index 82% rename from assets/js/90fd0dd1.7e6601a2.js rename to assets/js/90fd0dd1.f192b877.js index 348dc2d27..6883e1304 100644 --- a/assets/js/90fd0dd1.7e6601a2.js +++ b/assets/js/90fd0dd1.f192b877.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7519],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(r),h=n,m=s["".concat(p,".").concat(h)]||s[h]||k[h]||i;return r?a.createElement(m,l(l({ref:t},d),{},{components:r})):a.createElement(m,l({ref:t},d))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=h;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,l[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.FileBlockProps",title:"Interface: FileBlockProps",sidebar_label:"@headstartwp/core.react.FileBlockProps",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.FileBlockProps",id:"interfaces/headstartwp_core.react.FileBlockProps",title:"Interface: FileBlockProps",description:"@headstartwp/core.react.FileBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.FileBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.FileBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.FileBlockProps",title:"Interface: FileBlockProps",sidebar_label:"@headstartwp/core.react.FileBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.FetchHookOptions",permalink:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},next:{title:"@headstartwp/core.react.GroupBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"href",id:"href",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"showDownloadButton",id:"showdownloadbutton",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-9",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".FileBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"FileBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"href"},"href"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"href"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/FileBlock.tsx#L8"},"packages/core/src/react/blocks/FileBlock.tsx:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"id"},"id"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"id"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/FileBlock.tsx#L7"},"packages/core/src/react/blocks/FileBlock.tsx:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"showdownloadbutton"},"showDownloadButton"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"showDownloadButton"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/FileBlock.tsx#L9"},"packages/core/src/react/blocks/FileBlock.tsx:9")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7519],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>m});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),h=n,m=s["".concat(p,".").concat(h)]||s[h]||k[h]||i;return a?r.createElement(m,l(l({ref:t},d),{},{components:a})):r.createElement(m,l({ref:t},d))}));function m(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=h;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,l[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.FileBlockProps",title:"Interface: FileBlockProps",sidebar_label:"@headstartwp/core.react.FileBlockProps",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.FileBlockProps",id:"interfaces/headstartwp_core.react.FileBlockProps",title:"Interface: FileBlockProps",description:"@headstartwp/core.react.FileBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.FileBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.FileBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.FileBlockProps",title:"Interface: FileBlockProps",sidebar_label:"@headstartwp/core.react.FileBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.FetchHookOptions",permalink:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"},next:{title:"@headstartwp/core.react.GroupBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"href",id:"href",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"showDownloadButton",id:"showdownloadbutton",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-9",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".FileBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"FileBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"href"},"href"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"href"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/FileBlock.tsx#L8"},"packages/core/src/react/blocks/FileBlock.tsx:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"id"},"id"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"id"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/FileBlock.tsx#L7"},"packages/core/src/react/blocks/FileBlock.tsx:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"showdownloadbutton"},"showDownloadButton"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"showDownloadButton"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/FileBlock.tsx#L9"},"packages/core/src/react/blocks/FileBlock.tsx:9")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/912e5e58.75515907.js b/assets/js/912e5e58.200c9d3d.js similarity index 82% rename from assets/js/912e5e58.75515907.js rename to assets/js/912e5e58.200c9d3d.js index 8f101a766..c0d3d11d0 100644 --- a/assets/js/912e5e58.75515907.js +++ b/assets/js/912e5e58.200c9d3d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1362],{3905:(e,t,r)=>{r.d(t,{Zo:()=>i,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var s=a.createContext({}),p=function(e){var t=a.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},i=function(e){var t=p(e.components);return a.createElement(s.Provider,{value:t},e.children)},d="mdxType",f={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,s=e.parentName,i=c(e,["components","mdxType","originalType","parentName"]),d=p(r),u=n,m=d["".concat(s,".").concat(u)]||d[u]||f[u]||o;return r?a.createElement(m,l(l({ref:t},i),{},{components:r})):a.createElement(m,l({ref:t},i))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,l=new Array(o);l[0]=u;var c={};for(var s in t)hasOwnProperty.call(t,s)&&(c[s]=t[s]);c.originalType=e,c[d]="string"==typeof e?e:n,l[1]=c;for(var p=2;p{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>p});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.SafeHtmlProps",title:"Interface: SafeHtmlProps",sidebar_label:"@headstartwp/core.react.SafeHtmlProps",custom_edit_url:null},l=void 0,c={unversionedId:"interfaces/headstartwp_core.react.SafeHtmlProps",id:"interfaces/headstartwp_core.react.SafeHtmlProps",title:"Interface: SafeHtmlProps",description:"@headstartwp/core.react.SafeHtmlProps",source:"@site/docs/interfaces/headstartwp_core.react.SafeHtmlProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.SafeHtmlProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SafeHtmlProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.SafeHtmlProps",title:"Interface: SafeHtmlProps",sidebar_label:"@headstartwp/core.react.SafeHtmlProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.QuoteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps"},next:{title:"@headstartwp/core.react.SeparatorBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps"}},s={},p=[{value:"Properties",id:"properties",level:2},{value:"html",id:"html",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ksesAllowList",id:"ksesallowlist",level:3},{value:"Defined in",id:"defined-in-1",level:4}],i={toc:p};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},i,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".SafeHtmlProps"),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"html"},"html"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"html"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The HTML string to be rendered."),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-jsx"},'\n')),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/SafeHtml.tsx#L14"},"packages/core/src/react/components/SafeHtml.tsx:14")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ksesallowlist"},"ksesAllowList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"ksesAllowList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"IWhiteList")),(0,n.kt)("p",null,"The allow list for the parser"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-jsx"},'\n')),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/SafeHtml.tsx#L26"},"packages/core/src/react/components/SafeHtml.tsx:26")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1362],{3905:(e,t,r)=>{r.d(t,{Zo:()=>i,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},i=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",f={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,i=s(e,["components","mdxType","originalType","parentName"]),d=c(r),u=n,m=d["".concat(p,".").concat(u)]||d[u]||f[u]||o;return r?a.createElement(m,l(l({ref:t},i),{},{components:r})):a.createElement(m,l({ref:t},i))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,l=new Array(o);l[0]=u;var s={};for(var p in t)hasOwnProperty.call(t,p)&&(s[p]=t[p]);s.originalType=e,s[d]="string"==typeof e?e:n,l[1]=s;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.SafeHtmlProps",title:"Interface: SafeHtmlProps",sidebar_label:"@headstartwp/core.react.SafeHtmlProps",custom_edit_url:null},l=void 0,s={unversionedId:"interfaces/headstartwp_core.react.SafeHtmlProps",id:"interfaces/headstartwp_core.react.SafeHtmlProps",title:"Interface: SafeHtmlProps",description:"@headstartwp/core.react.SafeHtmlProps",source:"@site/docs/interfaces/headstartwp_core.react.SafeHtmlProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.SafeHtmlProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SafeHtmlProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.SafeHtmlProps",title:"Interface: SafeHtmlProps",sidebar_label:"@headstartwp/core.react.SafeHtmlProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.QuoteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps"},next:{title:"@headstartwp/core.react.SeparatorBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps"}},p={},c=[{value:"Properties",id:"properties",level:2},{value:"html",id:"html",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ksesAllowList",id:"ksesallowlist",level:3},{value:"Defined in",id:"defined-in-1",level:4}],i={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},i,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".SafeHtmlProps"),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"html"},"html"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"html"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The HTML string to be rendered."),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-jsx"},'\n')),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/SafeHtml.tsx#L14"},"packages/core/src/react/components/SafeHtml.tsx:14")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ksesallowlist"},"ksesAllowList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"ksesAllowList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"IWhiteList")),(0,n.kt)("p",null,"The allow list for the parser"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-jsx"},'\n')),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/SafeHtml.tsx#L26"},"packages/core/src/react/components/SafeHtml.tsx:26")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/92bb2d44.a98d79d5.js b/assets/js/92bb2d44.ca61c05e.js similarity index 97% rename from assets/js/92bb2d44.a98d79d5.js rename to assets/js/92bb2d44.ca61c05e.js index 9b30f3d3c..7a249997c 100644 --- a/assets/js/92bb2d44.a98d79d5.js +++ b/assets/js/92bb2d44.ca61c05e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7775],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||o;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,l=new Array(o);l[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:n,l[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.ISeparatorBlock",title:"Interface: ISeparatorBlock",sidebar_label:"@headstartwp/core.react.ISeparatorBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.ISeparatorBlock",id:"interfaces/headstartwp_core.react.ISeparatorBlock",title:"Interface: ISeparatorBlock",description:"@headstartwp/core.react.ISeparatorBlock",source:"@site/docs/interfaces/headstartwp_core.react.ISeparatorBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ISeparatorBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ISeparatorBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ISeparatorBlock",title:"Interface: ISeparatorBlock",sidebar_label:"@headstartwp/core.react.ISeparatorBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IQuoteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IQuoteBlock"},next:{title:"@headstartwp/core.react.ISpacerBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ISpacerBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ISeparatorBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SeparatorBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ISeparatorBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SeparatorBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SeparatorBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7775],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||o;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,l=new Array(o);l[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:n,l[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.ISeparatorBlock",title:"Interface: ISeparatorBlock",sidebar_label:"@headstartwp/core.react.ISeparatorBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.ISeparatorBlock",id:"interfaces/headstartwp_core.react.ISeparatorBlock",title:"Interface: ISeparatorBlock",description:"@headstartwp/core.react.ISeparatorBlock",source:"@site/docs/interfaces/headstartwp_core.react.ISeparatorBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ISeparatorBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ISeparatorBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ISeparatorBlock",title:"Interface: ISeparatorBlock",sidebar_label:"@headstartwp/core.react.ISeparatorBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IQuoteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IQuoteBlock"},next:{title:"@headstartwp/core.react.ISpacerBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ISpacerBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ISeparatorBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SeparatorBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ISeparatorBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SeparatorBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"SeparatorBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/935f2afb.022a7925.js b/assets/js/935f2afb.022a7925.js deleted file mode 100644 index 481048024..000000000 --- a/assets/js/935f2afb.022a7925.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Introduction","href":"/docs/learn/","docId":"index"},{"type":"category","label":"Getting Started","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Quick Setup","href":"/docs/learn/getting-started/quick-setup","docId":"Getting Started/quick-setup"},{"type":"link","label":"Setting up the framework from scratch","href":"/docs/learn/getting-started/setting-up-manually","docId":"Getting Started/setting-up-manually"},{"type":"link","label":"Configuring the Framework","href":"/docs/learn/getting-started/headless-config","docId":"Getting Started/headless-config"},{"type":"link","label":"Installing WordPress Plugin","href":"/docs/learn/getting-started/installing-wordpress-plugin","docId":"Getting Started/wordpress-plugin"},{"type":"link","label":"Quick Introduction to the Framework","href":"/docs/learn/getting-started/quick-tutorial","docId":"Getting Started/quick-tutorial"}]},{"type":"category","label":"Data Fetching","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Introduction","href":"/docs/learn/data-fetching","docId":"Data Fetching/introduction"},{"type":"link","label":"The usePost hook","href":"/docs/learn/data-fetching/usepost","docId":"Data Fetching/usePost"},{"type":"link","label":"The usePosts hook","href":"/docs/learn/data-fetching/useposts","docId":"Data Fetching/usePosts"},{"type":"link","label":"The useAuthorArchive Hook","href":"/docs/learn/data-fetching/useauthorarchive","docId":"Data Fetching/useAuthorArchive"},{"type":"link","label":"The usePostOrPosts hook","href":"/docs/learn/data-fetching/use-post-or-posts","docId":"Data Fetching/usePostOrPosts"},{"type":"link","label":"The useTerms hook","href":"/docs/learn/data-fetching/useterms","docId":"Data Fetching/useTerms"},{"type":"link","label":"The useSearch hook","href":"/docs/learn/data-fetching/usesearch","docId":"Data Fetching/useSearch"},{"type":"link","label":"The useSearchNative hook","href":"/docs/learn/data-fetching/usesearch-native","docId":"Data Fetching/useSearchNative"},{"type":"link","label":"The useSeo hook","href":"/docs/learn/data-fetching/useSeo","docId":"Data Fetching/useSeo"},{"type":"link","label":"Creating your own custom hooks","href":"/docs/learn/data-fetching/creating-your-own-custom-hooks","docId":"Data Fetching/custom-hooks"},{"type":"link","label":"Prefetching data on the server","href":"/docs/learn/data-fetching/prefetching","docId":"Data Fetching/prefetching-data-server"}]},{"type":"category","label":"Utilities","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Escaping & Sanitization","href":"/docs/learn/utilities/sanitization","docId":"Utilities/sanitization"}]},{"type":"category","label":"Gutenberg","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Rendering Blocks","href":"/docs/learn/gutenberg/rendering-blocks","docId":"Gutenberg/rendering-blocks"},{"type":"link","label":"Rendering Custom Blocks","href":"/docs/learn/gutenberg/rendering-custom-blocks","docId":"Gutenberg/rendering-custom-blocks"},{"type":"link","label":"Rendering Blocks in React Native","href":"/docs/learn/gutenberg/rendering-blocks-in-react-native","docId":"Gutenberg/rendering-blocks-in-react-native"}]},{"type":"category","label":"WordPress Integration","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Previews","href":"/docs/learn/wordpress-integration/previews","docId":"WordPress Integration/previews"},{"type":"link","label":"Multisite","href":"/docs/learn/wordpress-integration/multisite","docId":"WordPress Integration/multisite"},{"type":"link","label":"On-demand ISR revalidation","href":"/docs/learn/wordpress-integration/revalidate","docId":"WordPress Integration/revalidate"},{"type":"link","label":"Basic Auth","href":"/docs/learn/wordpress-integration/basic-auth","docId":"WordPress Integration/basic-auth"},{"type":"link","label":"Feeds","href":"/docs/learn/wordpress-integration/feeds","docId":"WordPress Integration/feeds"},{"type":"link","label":"Gutenberg","href":"/docs/learn/wordpress-integration/gutenberg","docId":"WordPress Integration/gutenberg"},{"type":"link","label":"Polylang Integration","href":"/docs/learn/wordpress-integration/polylang","docId":"WordPress Integration/polylang"}]},{"type":"category","label":"Guides","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"A/B Test SPA vs MPA navigation","href":"/docs/learn/Guides/ab-test-link","docId":"Guides/ab-test-link"},{"type":"link","label":"Linaria (CSS-in-JS)","href":"/docs/learn/Guides/linaria","docId":"Guides/linaria"},{"type":"link","label":"TypeScript","href":"/docs/learn/Guides/typescript","docId":"Guides/typescript"},{"type":"link","label":"Implementing a Youtube Facade","href":"/docs/learn/Guides/youtube-facade","docId":"Guides/youtube-facade"}]}]},"docs":{"Data Fetching/custom-hooks":{"id":"Data Fetching/custom-hooks","title":"Custom hooks","description":"Sometimes it might be useful to wrap the framework data-fetching hooks into your own hooks.","sidebar":"tutorialSidebar"},"Data Fetching/introduction":{"id":"Data Fetching/introduction","title":"Introduction","description":"HeadstartWP exposes several customs react hooks that provide a seamless data-fetching experience with WordPress. Those hooks are built to be \\"isomorphic\\" i.e can be executed either on the browser or on the server (e.g: Node.js).","sidebar":"tutorialSidebar"},"Data Fetching/prefetching-data-server":{"id":"Data Fetching/prefetching-data-server","title":"Prefetching data on the server","description":"To enable prefetching data on the server use the fetchHookData function alongside addHookData.","sidebar":"tutorialSidebar"},"Data Fetching/useAuthorArchive":{"id":"Data Fetching/useAuthorArchive","title":"The useAuthorArchive Hook","description":"The useAuthorArchive hook is the Next.js binding for the useFetchAuthorArchive.","sidebar":"tutorialSidebar"},"Data Fetching/usePost":{"id":"Data Fetching/usePost","title":"The usePost hook","description":"The usePost hook is the Next.js binding for the useFetchPost.","sidebar":"tutorialSidebar"},"Data Fetching/usePostOrPosts":{"id":"Data Fetching/usePostOrPosts","title":"The usePostOrPosts hook","description":"This hook was introduced in @headstartwp/core@1.1.0 and @headstartwp/next@1.1.0","sidebar":"tutorialSidebar"},"Data Fetching/usePosts":{"id":"Data Fetching/usePosts","title":"The usePosts hook","description":"The usePosts hook is the Next.js binding for the useFetchPosts.","sidebar":"tutorialSidebar"},"Data Fetching/useSearch":{"id":"Data Fetching/useSearch","title":"The useSearch hook","description":"The useSearch hook is the Next.js binding for the useFetchSearch.","sidebar":"tutorialSidebar"},"Data Fetching/useSearchNative":{"id":"Data Fetching/useSearchNative","title":"The useSearchNative hook","description":"The useSearchNative hook is the Next.js binding for the useFetchSearchNative.","sidebar":"tutorialSidebar"},"Data Fetching/useSeo":{"id":"Data Fetching/useSeo","title":"The useSeo hook","description":"This hook was introduced in @headstartwp/next@1.1.0","sidebar":"tutorialSidebar"},"Data Fetching/useTerms":{"id":"Data Fetching/useTerms","title":"The useTerms hook","description":"The useTerms hook is the Next.js binding for the useFetchTerms.","sidebar":"tutorialSidebar"},"Getting Started/headless-config":{"id":"Getting Started/headless-config","title":"Configuring the Framework","description":"The headstartwp.config.js (previously, headless.config.js) file contains several config options for HeadstartWP. This file should export an object of type HeadlessConfig.","sidebar":"tutorialSidebar"},"Getting Started/quick-setup":{"id":"Getting Started/quick-setup","title":"Quick Setup","description":"If you\'re new to Next.js, we recommend reviewing Next.js docs.","sidebar":"tutorialSidebar"},"Getting Started/quick-tutorial":{"id":"Getting Started/quick-tutorial","title":"Quick Introduction to the Framework","description":"Introduction","sidebar":"tutorialSidebar"},"Getting Started/setting-up-manually":{"id":"Getting Started/setting-up-manually","title":"Setting up the framework from scratch","description":"The recommended way to get started with the framework is by installing the official starter project. See Quick Setup for more information.","sidebar":"tutorialSidebar"},"Getting Started/wordpress-plugin":{"id":"Getting Started/wordpress-plugin","title":"Installing WordPress Plugin","description":"Composer Installation (Recommended)","sidebar":"tutorialSidebar"},"Guides/ab-test-link":{"id":"Guides/ab-test-link","title":"A/B Testing SPA vs MPA navigation","description":"In this guide, we\u2019ll implement a custom Link component that will replace every Link in the post content with a custom React component that will implement SPA or MPA navigation based on an A/B test. By \u201cSPA navigation\u201d I mean navigating to other pages via client-side rendering instead of a full-page reload. MPA navigation is the opposite and traditional way of navigation.","sidebar":"tutorialSidebar"},"Guides/linaria":{"id":"Guides/linaria","title":"Linaria (CSS-in-JS)","description":"HeadstartWP offers a straightforward integration with Linaria, a zero-runtime CSS-in-JS solution. To use it, simply install the following linaria packages.","sidebar":"tutorialSidebar"},"Guides/typescript":{"id":"Guides/typescript","title":"TypeScript","description":"","sidebar":"tutorialSidebar"},"Guides/youtube-facade":{"id":"Guides/youtube-facade","title":"Implementing a Youtube Facade","description":"HeadstartWP provides an easy way to implement Youtube Facade, in fact, we can do so with one line of code. All that\u2019s needed is to add the YoutubeLiteBlock component","sidebar":"tutorialSidebar"},"Gutenberg/rendering-blocks":{"id":"Gutenberg/rendering-blocks","title":"Rendering Blocks","description":"Introduction","sidebar":"tutorialSidebar"},"Gutenberg/rendering-blocks-in-react-native":{"id":"Gutenberg/rendering-blocks-in-react-native","title":"Rendering Blocks in React Native","description":"Introduction","sidebar":"tutorialSidebar"},"Gutenberg/rendering-custom-blocks":{"id":"Gutenberg/rendering-custom-blocks","title":"Rendering Custom Blocks","description":"Custom Blocks can be handled in a very similar way. If you need to render your custom block as a react component you should make sure that the block exposes its data via the markup. You can do so by appending additional data to the data-wp-block-attrs attribute or serializing the data needed inside the block.","sidebar":"tutorialSidebar"},"index":{"id":"index","title":"Introduction","description":"Welcome to HeadstartWP documentation site! If you are new, we highly recommend reading all the way through Getting Started first.","sidebar":"tutorialSidebar"},"Utilities/sanitization":{"id":"Utilities/sanitization","title":"Escaping & Sanitization","description":"As you\'re probably aware, React won\'t render raw HTML by default. If you want to do so you must use dangerouslySetInnerHTML.","sidebar":"tutorialSidebar"},"WordPress Integration/basic-auth":{"id":"WordPress Integration/basic-auth","title":"Basic Auth","description":"If WordPress is protected by Basic Auth (which is common during development) you can tell HeadstartWP the basic auth creds so that all","sidebar":"tutorialSidebar"},"WordPress Integration/feeds":{"id":"WordPress Integration/feeds","title":"Feeds","description":"Feeds are proxied via Next.js rewrites by default. meaning that you can directly access the feed via your front-end/Next.js URL.","sidebar":"tutorialSidebar"},"WordPress Integration/gutenberg":{"id":"WordPress Integration/gutenberg","title":"Gutenberg","description":"The HeadstartWP Plugin enhances every block with two special attributes directly in the markup: data-wp-block-name and data-wp-block. The first holds the name of the block and the second holds all of the block attributes.","sidebar":"tutorialSidebar"},"WordPress Integration/multisite":{"id":"WordPress Integration/multisite","title":"Multisite","description":"HeadstartWP has built-in support for WordPress multisite via the sites property in the headstartwp.config.js file. This transforms the Next.js app into a multi-tenant app.","sidebar":"tutorialSidebar"},"WordPress Integration/polylang":{"id":"WordPress Integration/polylang","title":"Polylang Integration","description":"Polylang Pro is required since only Polylang Pro offers the REST API integration.","sidebar":"tutorialSidebar"},"WordPress Integration/previews":{"id":"WordPress Integration/previews","title":"Previews","description":"The preview feature requires the HeadstartWP plugin installed. The preview functionality is built on top of Next.js preview API. It uses a short-lived JWT token generated on the WordPress side that can only be used for previewing, this means it is not necessary to set up a hardcoded secret between WP and Next.js.","sidebar":"tutorialSidebar"},"WordPress Integration/revalidate":{"id":"WordPress Integration/revalidate","title":"On-demand ISR revalidation","description":"On-demand Revalidation is the ability to revalidate static pages programmatically from the CMS.","sidebar":"tutorialSidebar"}}}')}}]); \ No newline at end of file diff --git a/assets/js/935f2afb.7b6f4ab0.js b/assets/js/935f2afb.7b6f4ab0.js new file mode 100644 index 000000000..840fc270b --- /dev/null +++ b/assets/js/935f2afb.7b6f4ab0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Introduction","href":"/docs/learn/","docId":"index"},{"type":"category","label":"Getting Started","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Quick Setup","href":"/docs/learn/getting-started/quick-setup","docId":"Getting Started/quick-setup"},{"type":"link","label":"Setting up the framework from scratch","href":"/docs/learn/getting-started/setting-up-manually","docId":"Getting Started/setting-up-manually"},{"type":"link","label":"Configuring the Framework","href":"/docs/learn/getting-started/headless-config","docId":"Getting Started/headless-config"},{"type":"link","label":"Installing WordPress Plugin","href":"/docs/learn/getting-started/installing-wordpress-plugin","docId":"Getting Started/wordpress-plugin"},{"type":"link","label":"Quick Introduction to the Framework","href":"/docs/learn/getting-started/quick-tutorial","docId":"Getting Started/quick-tutorial"}]},{"type":"category","label":"Data Fetching","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Introduction","href":"/docs/learn/data-fetching","docId":"Data Fetching/introduction"},{"type":"link","label":"The usePost hook","href":"/docs/learn/data-fetching/usepost","docId":"Data Fetching/usePost"},{"type":"link","label":"The usePosts hook","href":"/docs/learn/data-fetching/useposts","docId":"Data Fetching/usePosts"},{"type":"link","label":"The useAuthorArchive Hook","href":"/docs/learn/data-fetching/useauthorarchive","docId":"Data Fetching/useAuthorArchive"},{"type":"link","label":"The usePostOrPosts hook","href":"/docs/learn/data-fetching/use-post-or-posts","docId":"Data Fetching/usePostOrPosts"},{"type":"link","label":"The useTerms hook","href":"/docs/learn/data-fetching/useterms","docId":"Data Fetching/useTerms"},{"type":"link","label":"The useSearch hook","href":"/docs/learn/data-fetching/usesearch","docId":"Data Fetching/useSearch"},{"type":"link","label":"The useSearchNative hook","href":"/docs/learn/data-fetching/usesearch-native","docId":"Data Fetching/useSearchNative"},{"type":"link","label":"The useSeo hook","href":"/docs/learn/data-fetching/useSeo","docId":"Data Fetching/useSeo"},{"type":"link","label":"Mutating Data","href":"/docs/learn/data-fetching/mutating","docId":"Data Fetching/mutating"},{"type":"link","label":"Creating your own custom hooks","href":"/docs/learn/data-fetching/creating-your-own-custom-hooks","docId":"Data Fetching/custom-hooks"},{"type":"link","label":"Prefetching data on the server","href":"/docs/learn/data-fetching/prefetching","docId":"Data Fetching/prefetching-data-server"}]},{"type":"category","label":"Utilities","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Escaping & Sanitization","href":"/docs/learn/utilities/sanitization","docId":"Utilities/sanitization"}]},{"type":"category","label":"Gutenberg","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Rendering Blocks","href":"/docs/learn/gutenberg/rendering-blocks","docId":"Gutenberg/rendering-blocks"},{"type":"link","label":"Rendering Custom Blocks","href":"/docs/learn/gutenberg/rendering-custom-blocks","docId":"Gutenberg/rendering-custom-blocks"},{"type":"link","label":"Rendering Blocks in React Native","href":"/docs/learn/gutenberg/rendering-blocks-in-react-native","docId":"Gutenberg/rendering-blocks-in-react-native"}]},{"type":"category","label":"WordPress Integration","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Previews","href":"/docs/learn/wordpress-integration/previews","docId":"WordPress Integration/previews"},{"type":"link","label":"Multisite","href":"/docs/learn/wordpress-integration/multisite","docId":"WordPress Integration/multisite"},{"type":"link","label":"On-demand ISR revalidation","href":"/docs/learn/wordpress-integration/revalidate","docId":"WordPress Integration/revalidate"},{"type":"link","label":"Basic Auth","href":"/docs/learn/wordpress-integration/basic-auth","docId":"WordPress Integration/basic-auth"},{"type":"link","label":"Feeds","href":"/docs/learn/wordpress-integration/feeds","docId":"WordPress Integration/feeds"},{"type":"link","label":"Gutenberg","href":"/docs/learn/wordpress-integration/gutenberg","docId":"WordPress Integration/gutenberg"},{"type":"link","label":"Polylang Integration","href":"/docs/learn/wordpress-integration/polylang","docId":"WordPress Integration/polylang"}]},{"type":"category","label":"Guides","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"A/B Test SPA vs MPA navigation","href":"/docs/learn/Guides/ab-test-link","docId":"Guides/ab-test-link"},{"type":"link","label":"Linaria (CSS-in-JS)","href":"/docs/learn/Guides/linaria","docId":"Guides/linaria"},{"type":"link","label":"TypeScript","href":"/docs/learn/Guides/typescript","docId":"Guides/typescript"},{"type":"link","label":"Implementing a Youtube Facade","href":"/docs/learn/Guides/youtube-facade","docId":"Guides/youtube-facade"}]}]},"docs":{"Data Fetching/custom-hooks":{"id":"Data Fetching/custom-hooks","title":"Custom hooks","description":"Sometimes it might be useful to wrap the framework data-fetching hooks into your own hooks.","sidebar":"tutorialSidebar"},"Data Fetching/introduction":{"id":"Data Fetching/introduction","title":"Introduction","description":"HeadstartWP exposes several customs react hooks that provide a seamless data-fetching experience with WordPress. Those hooks are built to be \\"isomorphic\\" i.e can be executed either on the browser or on the server (e.g: Node.js).","sidebar":"tutorialSidebar"},"Data Fetching/mutating":{"id":"Data Fetching/mutating","title":"Mutating Data","description":"It is possible to use the useSwr mutate function to mutate data on the client. The data-fetching hooks expose the \\"bound mutate\\" function from swr. Below is an example of optimistically updating the UI to like a post.","sidebar":"tutorialSidebar"},"Data Fetching/prefetching-data-server":{"id":"Data Fetching/prefetching-data-server","title":"Prefetching data on the server","description":"To enable prefetching data on the server use the fetchHookData function alongside addHookData.","sidebar":"tutorialSidebar"},"Data Fetching/useAuthorArchive":{"id":"Data Fetching/useAuthorArchive","title":"The useAuthorArchive Hook","description":"The useAuthorArchive hook is the Next.js binding for the useFetchAuthorArchive.","sidebar":"tutorialSidebar"},"Data Fetching/usePost":{"id":"Data Fetching/usePost","title":"The usePost hook","description":"The usePost hook is the Next.js binding for the useFetchPost.","sidebar":"tutorialSidebar"},"Data Fetching/usePostOrPosts":{"id":"Data Fetching/usePostOrPosts","title":"The usePostOrPosts hook","description":"This hook was introduced in @headstartwp/core@1.1.0 and @headstartwp/next@1.1.0","sidebar":"tutorialSidebar"},"Data Fetching/usePosts":{"id":"Data Fetching/usePosts","title":"The usePosts hook","description":"The usePosts hook is the Next.js binding for the useFetchPosts.","sidebar":"tutorialSidebar"},"Data Fetching/useSearch":{"id":"Data Fetching/useSearch","title":"The useSearch hook","description":"The useSearch hook is the Next.js binding for the useFetchSearch.","sidebar":"tutorialSidebar"},"Data Fetching/useSearchNative":{"id":"Data Fetching/useSearchNative","title":"The useSearchNative hook","description":"The useSearchNative hook is the Next.js binding for the useFetchSearchNative.","sidebar":"tutorialSidebar"},"Data Fetching/useSeo":{"id":"Data Fetching/useSeo","title":"The useSeo hook","description":"This hook was introduced in @headstartwp/next@1.1.0","sidebar":"tutorialSidebar"},"Data Fetching/useTerms":{"id":"Data Fetching/useTerms","title":"The useTerms hook","description":"The useTerms hook is the Next.js binding for the useFetchTerms.","sidebar":"tutorialSidebar"},"Getting Started/headless-config":{"id":"Getting Started/headless-config","title":"Configuring the Framework","description":"The headstartwp.config.js (previously, headless.config.js) file contains several config options for HeadstartWP. This file should export an object of type HeadlessConfig.","sidebar":"tutorialSidebar"},"Getting Started/quick-setup":{"id":"Getting Started/quick-setup","title":"Quick Setup","description":"If you\'re new to Next.js, we recommend reviewing Next.js docs.","sidebar":"tutorialSidebar"},"Getting Started/quick-tutorial":{"id":"Getting Started/quick-tutorial","title":"Quick Introduction to the Framework","description":"Introduction","sidebar":"tutorialSidebar"},"Getting Started/setting-up-manually":{"id":"Getting Started/setting-up-manually","title":"Setting up the framework from scratch","description":"The recommended way to get started with the framework is by installing the official starter project. See Quick Setup for more information.","sidebar":"tutorialSidebar"},"Getting Started/wordpress-plugin":{"id":"Getting Started/wordpress-plugin","title":"Installing WordPress Plugin","description":"Composer Installation (Recommended)","sidebar":"tutorialSidebar"},"Guides/ab-test-link":{"id":"Guides/ab-test-link","title":"A/B Testing SPA vs MPA navigation","description":"In this guide, we\u2019ll implement a custom Link component that will replace every Link in the post content with a custom React component that will implement SPA or MPA navigation based on an A/B test. By \u201cSPA navigation\u201d I mean navigating to other pages via client-side rendering instead of a full-page reload. MPA navigation is the opposite and traditional way of navigation.","sidebar":"tutorialSidebar"},"Guides/linaria":{"id":"Guides/linaria","title":"Linaria (CSS-in-JS)","description":"HeadstartWP offers a straightforward integration with Linaria, a zero-runtime CSS-in-JS solution. To use it, simply install the following linaria packages.","sidebar":"tutorialSidebar"},"Guides/typescript":{"id":"Guides/typescript","title":"TypeScript","description":"","sidebar":"tutorialSidebar"},"Guides/youtube-facade":{"id":"Guides/youtube-facade","title":"Implementing a Youtube Facade","description":"HeadstartWP provides an easy way to implement Youtube Facade, in fact, we can do so with one line of code. All that\u2019s needed is to add the YoutubeLiteBlock component","sidebar":"tutorialSidebar"},"Gutenberg/rendering-blocks":{"id":"Gutenberg/rendering-blocks","title":"Rendering Blocks","description":"Introduction","sidebar":"tutorialSidebar"},"Gutenberg/rendering-blocks-in-react-native":{"id":"Gutenberg/rendering-blocks-in-react-native","title":"Rendering Blocks in React Native","description":"Introduction","sidebar":"tutorialSidebar"},"Gutenberg/rendering-custom-blocks":{"id":"Gutenberg/rendering-custom-blocks","title":"Rendering Custom Blocks","description":"Custom Blocks can be handled in a very similar way. If you need to render your custom block as a react component you should make sure that the block exposes its data via the markup. You can do so by appending additional data to the data-wp-block-attrs attribute or serializing the data needed inside the block.","sidebar":"tutorialSidebar"},"index":{"id":"index","title":"Introduction","description":"Welcome to HeadstartWP documentation site! If you are new, we highly recommend reading all the way through Getting Started first.","sidebar":"tutorialSidebar"},"Utilities/sanitization":{"id":"Utilities/sanitization","title":"Escaping & Sanitization","description":"As you\'re probably aware, React won\'t render raw HTML by default. If you want to do so you must use dangerouslySetInnerHTML.","sidebar":"tutorialSidebar"},"WordPress Integration/basic-auth":{"id":"WordPress Integration/basic-auth","title":"Basic Auth","description":"If WordPress is protected by Basic Auth (which is common during development) you can tell HeadstartWP the basic auth creds so that all","sidebar":"tutorialSidebar"},"WordPress Integration/feeds":{"id":"WordPress Integration/feeds","title":"Feeds","description":"Feeds are proxied via Next.js rewrites by default. meaning that you can directly access the feed via your front-end/Next.js URL.","sidebar":"tutorialSidebar"},"WordPress Integration/gutenberg":{"id":"WordPress Integration/gutenberg","title":"Gutenberg","description":"The HeadstartWP Plugin enhances every block with two special attributes directly in the markup: data-wp-block-name and data-wp-block. The first holds the name of the block and the second holds all of the block attributes.","sidebar":"tutorialSidebar"},"WordPress Integration/multisite":{"id":"WordPress Integration/multisite","title":"Multisite","description":"HeadstartWP has built-in support for WordPress multisite via the sites property in the headstartwp.config.js file. This transforms the Next.js app into a multi-tenant app.","sidebar":"tutorialSidebar"},"WordPress Integration/polylang":{"id":"WordPress Integration/polylang","title":"Polylang Integration","description":"Polylang Pro is required since only Polylang Pro offers the REST API integration.","sidebar":"tutorialSidebar"},"WordPress Integration/previews":{"id":"WordPress Integration/previews","title":"Previews","description":"The preview feature requires the HeadstartWP plugin installed. The preview functionality is built on top of Next.js preview API. It uses a short-lived JWT token generated on the WordPress side that can only be used for previewing, this means it is not necessary to set up a hardcoded secret between WP and Next.js.","sidebar":"tutorialSidebar"},"WordPress Integration/revalidate":{"id":"WordPress Integration/revalidate","title":"On-demand ISR revalidation","description":"On-demand Revalidation is the ability to revalidate static pages programmatically from the CMS.","sidebar":"tutorialSidebar"}}}')}}]); \ No newline at end of file diff --git a/assets/js/93679912.5c495599.js b/assets/js/93679912.7f57563f.js similarity index 97% rename from assets/js/93679912.5c495599.js rename to assets/js/93679912.7f57563f.js index 1beb040ab..07a85920c 100644 --- a/assets/js/93679912.5c495599.js +++ b/assets/js/93679912.7f57563f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7870],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var s=r.createContext({}),d=function(e){var t=r.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=d(e.components);return r.createElement(s.Provider,{value:t},e.children)},h="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,s=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),h=d(a),m=n,k=h["".concat(s,".").concat(m)]||h[m]||c[m]||i;return a?r.createElement(k,p(p({ref:t},o),{},{components:a})):r.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=m;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[h]="string"==typeof e?e:n,p[1]=l;for(var d=2;d{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>h,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.SearchFetchStrategy",title:"Class: SearchFetchStrategy",sidebar_label:"@headstartwp/core.SearchFetchStrategy",custom_edit_url:null},p=void 0,l={unversionedId:"classes/headstartwp_core.SearchFetchStrategy",id:"classes/headstartwp_core.SearchFetchStrategy",title:"Class: SearchFetchStrategy",description:"@headstartwp/core.SearchFetchStrategy",source:"@site/docs/classes/headstartwp_core.SearchFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.SearchFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.SearchFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.SearchFetchStrategy",title:"Class: SearchFetchStrategy",sidebar_label:"@headstartwp/core.SearchFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.ProcessingInstruction",permalink:"/docs/api/classes/headstartwp_core.ProcessingInstruction"},next:{title:"@headstartwp/core.SearchNativeFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.SearchNativeFetchStrategy"}},s={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"locale",id:"locale",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"path",id:"path",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getPreviewAuthHeader",id:"getpreviewauthheader",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"getPreviewHeaderName",id:"getpreviewheadername",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"Defined in",id:"defined-in-23",level:4}],o={toc:d};function h(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".SearchFetchStrategy"),(0,n.kt)("p",null,"The SearchFetchStrategy extends the ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy")," and does not make use of the\nsearch endpoint. Instead it uses the specified postType endpoint."),(0,n.kt)("p",null,"This strategy supports extracting endpoint params from url E.g:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/page/2/")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ page: 2 }")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/searched-term/page/2")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ search: 'searched-term', page: 2 }"))),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"SearchFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new SearchFetchStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L143"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:143")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L119"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:119")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L124"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:124")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"locale"},"locale"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"locale"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#locale"},"locale")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L212"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:212")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"path"},"path"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"path"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#path"},"path")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L210"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:210")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Handles taxonomy filters and switch endpoint based on post type"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint with")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L289"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:289")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,n.kt)("inlineCode",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[] }",">"),(0,n.kt)("p",null,"The fetcher function is overridden to disable throwing if not found"),(0,n.kt)("p",null,"If a search request returns not found we do not want to redirect to a 404 page,\ninstead the user should be informed that no posts were found"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The url to parse")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint with")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"FetchOptions")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,n.kt)("inlineCode",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[] }",">"),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SearchFetchStrategy.ts#L46"},"packages/core/src/data/strategies/SearchFetchStrategy.ts:46")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L530"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:530")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L442"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:442")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L256"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:256")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L407"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:407")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SearchFetchStrategy.ts#L24"},"packages/core/src/data/strategies/SearchFetchStrategy.ts:24")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L218"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:218")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L174"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:174")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"This strategy automatically extracts taxonomy filters, date filters and pagination params from the URL"),(0,n.kt)("p",null,"It also takes into account the custom taxonomies specified in ",(0,n.kt)("inlineCode",{parentName:"p"},"headless.config.js")),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL path to extract params from")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"})))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides-2"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SearchFetchStrategy.ts#L28"},"packages/core/src/data/strategies/SearchFetchStrategy.ts:28")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewauthheader"},"getPreviewAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getpreviewauthheader"},"getPreviewAuthHeader")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L247"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:247")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewheadername"},"getPreviewHeaderName"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewHeaderName"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getpreviewheadername"},"getPreviewHeaderName")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L241"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:241")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))),(0,n.kt)("p",null,"Returns the queried object if applicable (e.g if querying by category, tag, author or custom taxonomy term)"),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The response from the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))),(0,n.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L461"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:461")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L205"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:205")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L417"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:417")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L327"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:327")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-14"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-16"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-19"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L164"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:164")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-15"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-17"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-20"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")))}h.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7870],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var s=r.createContext({}),d=function(e){var t=r.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=d(e.components);return r.createElement(s.Provider,{value:t},e.children)},h="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,s=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),h=d(a),m=n,k=h["".concat(s,".").concat(m)]||h[m]||c[m]||i;return a?r.createElement(k,p(p({ref:t},o),{},{components:a})):r.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=m;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[h]="string"==typeof e?e:n,p[1]=l;for(var d=2;d{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>h,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.SearchFetchStrategy",title:"Class: SearchFetchStrategy",sidebar_label:"@headstartwp/core.SearchFetchStrategy",custom_edit_url:null},p=void 0,l={unversionedId:"classes/headstartwp_core.SearchFetchStrategy",id:"classes/headstartwp_core.SearchFetchStrategy",title:"Class: SearchFetchStrategy",description:"@headstartwp/core.SearchFetchStrategy",source:"@site/docs/classes/headstartwp_core.SearchFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.SearchFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.SearchFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.SearchFetchStrategy",title:"Class: SearchFetchStrategy",sidebar_label:"@headstartwp/core.SearchFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.ProcessingInstruction",permalink:"/docs/api/classes/headstartwp_core.ProcessingInstruction"},next:{title:"@headstartwp/core.SearchNativeFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.SearchNativeFetchStrategy"}},s={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"locale",id:"locale",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"path",id:"path",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getPreviewAuthHeader",id:"getpreviewauthheader",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"getPreviewHeaderName",id:"getpreviewheadername",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"Defined in",id:"defined-in-23",level:4}],o={toc:d};function h(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".SearchFetchStrategy"),(0,n.kt)("p",null,"The SearchFetchStrategy extends the ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy")," and does not make use of the\nsearch endpoint. Instead it uses the specified postType endpoint."),(0,n.kt)("p",null,"This strategy supports extracting endpoint params from url E.g:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/page/2/")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ page: 2 }")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/searched-term/page/2")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ search: 'searched-term', page: 2 }"))),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"SearchFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new SearchFetchStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L143"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:143")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L119"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:119")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L124"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:124")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"locale"},"locale"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"locale"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#locale"},"locale")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L212"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:212")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"path"},"path"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"path"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#path"},"path")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L210"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:210")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Handles taxonomy filters and switch endpoint based on post type"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint with")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L289"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:289")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,n.kt)("inlineCode",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[] }",">"),(0,n.kt)("p",null,"The fetcher function is overridden to disable throwing if not found"),(0,n.kt)("p",null,"If a search request returns not found we do not want to redirect to a 404 page,\ninstead the user should be informed that no posts were found"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The url to parse")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint with")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"FetchOptions")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,n.kt)("inlineCode",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[] }",">"),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SearchFetchStrategy.ts#L46"},"packages/core/src/data/strategies/SearchFetchStrategy.ts:46")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L530"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:530")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L442"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:442")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L256"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:256")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L407"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:407")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SearchFetchStrategy.ts#L24"},"packages/core/src/data/strategies/SearchFetchStrategy.ts:24")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L218"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:218")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L174"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:174")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"This strategy automatically extracts taxonomy filters, date filters and pagination params from the URL"),(0,n.kt)("p",null,"It also takes into account the custom taxonomies specified in ",(0,n.kt)("inlineCode",{parentName:"p"},"headless.config.js")),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL path to extract params from")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"})))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides-2"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SearchFetchStrategy.ts#L28"},"packages/core/src/data/strategies/SearchFetchStrategy.ts:28")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewauthheader"},"getPreviewAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getpreviewauthheader"},"getPreviewAuthHeader")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L247"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:247")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewheadername"},"getPreviewHeaderName"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewHeaderName"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getpreviewheadername"},"getPreviewHeaderName")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L241"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:241")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))),(0,n.kt)("p",null,"Returns the queried object if applicable (e.g if querying by category, tag, author or custom taxonomy term)"),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The response from the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))),(0,n.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L461"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:461")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L205"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:205")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L417"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:417")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L327"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:327")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-14"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-16"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-19"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L164"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:164")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-15"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-17"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-20"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/950ec5f2.68213f6d.js b/assets/js/950ec5f2.4d4cb394.js similarity index 97% rename from assets/js/950ec5f2.68213f6d.js rename to assets/js/950ec5f2.4d4cb394.js index f574d6f29..e542130e2 100644 --- a/assets/js/950ec5f2.68213f6d.js +++ b/assets/js/950ec5f2.4d4cb394.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4909],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var s=r.createContext({}),d=function(e){var t=r.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=d(e.components);return r.createElement(s.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,s=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),c=d(a),m=n,k=c["".concat(s,".").concat(m)]||c[m]||h[m]||i;return a?r.createElement(k,p(p({ref:t},o),{},{components:a})):r.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=m;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[c]="string"==typeof e?e:n,p[1]=l;for(var d=2;d{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.PostsArchiveFetchStrategy",title:"Class: PostsArchiveFetchStrategy",sidebar_label:"@headstartwp/core.PostsArchiveFetchStrategy",custom_edit_url:null},p=void 0,l={unversionedId:"classes/headstartwp_core.PostsArchiveFetchStrategy",id:"classes/headstartwp_core.PostsArchiveFetchStrategy",title:"Class: PostsArchiveFetchStrategy",description:"@headstartwp/core.PostsArchiveFetchStrategy",source:"@site/docs/classes/headstartwp_core.PostsArchiveFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.PostsArchiveFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostsArchiveFetchStrategy",title:"Class: PostsArchiveFetchStrategy",sidebar_label:"@headstartwp/core.PostsArchiveFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PostOrPostsFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy"},next:{title:"@headstartwp/core.ProcessingInstruction",permalink:"/docs/api/classes/headstartwp_core.ProcessingInstruction"}},s={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"locale",id:"locale",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"path",id:"path",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Overrides",id:"overrides-4",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-5",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getPreviewAuthHeader",id:"getpreviewauthheader",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"getPreviewHeaderName",id:"getpreviewheadername",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Overrides",id:"overrides-6",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Overrides",id:"overrides-7",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-23",level:4}],o={toc:d};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostsArchiveFetchStrategy"),(0,n.kt)("p",null,"The PostsArchiveFetchStrategy is used to fetch a collection of posts from any post type.\nNote that custom post types and custom taxonomies should be defined in ",(0,n.kt)("inlineCode",{parentName:"p"},"headless.config.js")),(0,n.kt)("p",null,"This strategy supports extracting endpoint params from url E.g:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/category/cat-name/page/2")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ category: 'cat-name', page: 2 }")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/page/2/")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ page: 2 }")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/genre/genre-name/page/2")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ genre: 'genre-name', page: 2 }")," if a ",(0,n.kt)("inlineCode",{parentName:"li"},"genre")," taxonomy is defined in ",(0,n.kt)("inlineCode",{parentName:"li"},"headless.config.js"))),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"See"))),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getparamsfromurl"},"getParamsFromURL")," to learn about url param mapping"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"PostsArchiveFetchStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.SearchFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"SearchFetchStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AuthorArchiveFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new PostsArchiveFetchStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L143"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:143")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L119"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:119")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L124"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:124")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"locale"},"locale"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"locale"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L212"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:212")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"path"},"path"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"path"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L210"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:210")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Handles taxonomy filters and switch endpoint based on post type"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint with")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L289"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:289")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"Before fetching posts, we need handle taxonomy and authors."),(0,n.kt)("p",null,"If the headless plugin is not being used, then additional requests needs to be made to get\nauthors and terms ids"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL to parse")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint with")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"FetchOptions")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L393"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:393")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"overrides-2"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L530"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:530")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L442"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:442")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L256"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:256")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L407"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:407")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides-3"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L214"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:214")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides-4"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L218"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:218")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L174"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:174")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"This strategy automatically extracts taxonomy filters, date filters and pagination params from the URL"),(0,n.kt)("p",null,"It also takes into account the custom taxonomies specified in ",(0,n.kt)("inlineCode",{parentName:"p"},"headless.config.js")),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL path to extract params from")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"})))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides-5"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L230"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:230")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewauthheader"},"getPreviewAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getpreviewauthheader"},"getPreviewAuthHeader")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L247"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:247")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewheadername"},"getPreviewHeaderName"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewHeaderName"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getpreviewheadername"},"getPreviewHeaderName")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L241"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:241")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))),(0,n.kt)("p",null,"Returns the queried object if applicable (e.g if querying by category, tag, author or custom taxonomy term)"),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The response from the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))),(0,n.kt)("h4",{id:"overrides-6"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L461"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:461")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L205"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:205")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L417"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:417")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"overrides-7"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L327"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:327")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-14"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-16"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L164"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:164")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-15"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-17"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4909],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var s=r.createContext({}),d=function(e){var t=r.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=d(e.components);return r.createElement(s.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,s=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),c=d(a),m=n,k=c["".concat(s,".").concat(m)]||c[m]||h[m]||i;return a?r.createElement(k,p(p({ref:t},o),{},{components:a})):r.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=m;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[c]="string"==typeof e?e:n,p[1]=l;for(var d=2;d{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.PostsArchiveFetchStrategy",title:"Class: PostsArchiveFetchStrategy",sidebar_label:"@headstartwp/core.PostsArchiveFetchStrategy",custom_edit_url:null},p=void 0,l={unversionedId:"classes/headstartwp_core.PostsArchiveFetchStrategy",id:"classes/headstartwp_core.PostsArchiveFetchStrategy",title:"Class: PostsArchiveFetchStrategy",description:"@headstartwp/core.PostsArchiveFetchStrategy",source:"@site/docs/classes/headstartwp_core.PostsArchiveFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.PostsArchiveFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostsArchiveFetchStrategy",title:"Class: PostsArchiveFetchStrategy",sidebar_label:"@headstartwp/core.PostsArchiveFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PostOrPostsFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy"},next:{title:"@headstartwp/core.ProcessingInstruction",permalink:"/docs/api/classes/headstartwp_core.ProcessingInstruction"}},s={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"locale",id:"locale",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"path",id:"path",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Overrides",id:"overrides-4",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-5",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getPreviewAuthHeader",id:"getpreviewauthheader",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"getPreviewHeaderName",id:"getpreviewheadername",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Overrides",id:"overrides-6",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Overrides",id:"overrides-7",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-23",level:4}],o={toc:d};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostsArchiveFetchStrategy"),(0,n.kt)("p",null,"The PostsArchiveFetchStrategy is used to fetch a collection of posts from any post type.\nNote that custom post types and custom taxonomies should be defined in ",(0,n.kt)("inlineCode",{parentName:"p"},"headless.config.js")),(0,n.kt)("p",null,"This strategy supports extracting endpoint params from url E.g:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/category/cat-name/page/2")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ category: 'cat-name', page: 2 }")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/page/2/")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ page: 2 }")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/genre/genre-name/page/2")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ genre: 'genre-name', page: 2 }")," if a ",(0,n.kt)("inlineCode",{parentName:"li"},"genre")," taxonomy is defined in ",(0,n.kt)("inlineCode",{parentName:"li"},"headless.config.js"))),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"See"))),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getparamsfromurl"},"getParamsFromURL")," to learn about url param mapping"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"PostsArchiveFetchStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.SearchFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"SearchFetchStrategy"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AuthorArchiveFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new PostsArchiveFetchStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L143"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:143")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L119"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:119")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L124"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:124")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"locale"},"locale"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"locale"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L212"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:212")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"path"},"path"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"path"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L210"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:210")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Handles taxonomy filters and switch endpoint based on post type"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint with")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L289"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:289")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"Before fetching posts, we need handle taxonomy and authors."),(0,n.kt)("p",null,"If the headless plugin is not being used, then additional requests needs to be made to get\nauthors and terms ids"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL to parse")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint with")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"FetchOptions")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L393"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:393")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"overrides-2"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L530"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:530")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L442"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:442")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L256"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:256")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L407"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:407")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides-3"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L214"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:214")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides-4"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L218"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:218")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L174"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:174")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"This strategy automatically extracts taxonomy filters, date filters and pagination params from the URL"),(0,n.kt)("p",null,"It also takes into account the custom taxonomies specified in ",(0,n.kt)("inlineCode",{parentName:"p"},"headless.config.js")),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL path to extract params from")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"})))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides-5"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L230"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:230")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewauthheader"},"getPreviewAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getpreviewauthheader"},"getPreviewAuthHeader")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L247"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:247")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewheadername"},"getPreviewHeaderName"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewHeaderName"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getpreviewheadername"},"getPreviewHeaderName")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L241"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:241")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))),(0,n.kt)("p",null,"Returns the queried object if applicable (e.g if querying by category, tag, author or custom taxonomy term)"),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The response from the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))),(0,n.kt)("h4",{id:"overrides-6"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L461"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:461")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L205"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:205")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L417"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:417")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"overrides-7"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L327"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:327")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-14"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-16"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L164"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:164")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-15"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-17"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/960bca7a.a19821ab.js b/assets/js/960bca7a.c50debeb.js similarity index 80% rename from assets/js/960bca7a.a19821ab.js rename to assets/js/960bca7a.c50debeb.js index ffc2d9c45..701fd7174 100644 --- a/assets/js/960bca7a.a19821ab.js +++ b/assets/js/960bca7a.c50debeb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6809],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>f});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var s=n.createContext({}),c=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},p=function(e){var t=c(e.components);return n.createElement(s.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),d=c(r),m=a,f=d["".concat(s,".").concat(m)]||d[m]||u[m]||i;return r?n.createElement(f,o(o({ref:t},p),{},{components:r})):n.createElement(f,o({ref:t},p))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,o=new Array(i);o[0]=m;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[d]="string"==typeof e?e:a,o[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var n=r(7462),a=(r(7294),r(3905));const i={id:"headstartwp_core.LOGTYPE",title:"Enumeration: LOGTYPE",sidebar_label:"@headstartwp/core.LOGTYPE",custom_edit_url:null},o=void 0,l={unversionedId:"enums/headstartwp_core.LOGTYPE",id:"enums/headstartwp_core.LOGTYPE",title:"Enumeration: LOGTYPE",description:"@headstartwp/core.LOGTYPE",source:"@site/docs/enums/headstartwp_core.LOGTYPE.md",sourceDirName:"enums",slug:"/enums/headstartwp_core.LOGTYPE",permalink:"/docs/api/enums/headstartwp_core.LOGTYPE",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.LOGTYPE",title:"Enumeration: LOGTYPE",sidebar_label:"@headstartwp/core.LOGTYPE",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/next.middlewares",permalink:"/docs/api/namespaces/headstartwp_next.middlewares"},next:{title:"@headstartwp/core.AbstractFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"}},s={},c=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"DEBUG",id:"debug",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ERROR",id:"error",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"INFO",id:"info",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"WARN",id:"warn",level:3},{value:"Defined in",id:"defined-in-3",level:4}],p={toc:c};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".LOGTYPE"),(0,a.kt)("h2",{id:"enumeration-members"},"Enumeration Members"),(0,a.kt)("h3",{id:"debug"},"DEBUG"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"DEBUG")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"0")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/log.ts#L3"},"packages/core/src/utils/log.ts:3")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"error"},"ERROR"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"ERROR")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"3")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/log.ts#L6"},"packages/core/src/utils/log.ts:6")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"info"},"INFO"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"INFO")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"1")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/log.ts#L4"},"packages/core/src/utils/log.ts:4")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"warn"},"WARN"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"WARN")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"2")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/log.ts#L5"},"packages/core/src/utils/log.ts:5")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6809],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>f});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var s=n.createContext({}),p=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},c=function(e){var t=p(e.components);return n.createElement(s.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),d=p(r),m=a,f=d["".concat(s,".").concat(m)]||d[m]||u[m]||i;return r?n.createElement(f,o(o({ref:t},c),{},{components:r})):n.createElement(f,o({ref:t},c))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,o=new Array(i);o[0]=m;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[d]="string"==typeof e?e:a,o[1]=l;for(var p=2;p{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>l,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const i={id:"headstartwp_core.LOGTYPE",title:"Enumeration: LOGTYPE",sidebar_label:"@headstartwp/core.LOGTYPE",custom_edit_url:null},o=void 0,l={unversionedId:"enums/headstartwp_core.LOGTYPE",id:"enums/headstartwp_core.LOGTYPE",title:"Enumeration: LOGTYPE",description:"@headstartwp/core.LOGTYPE",source:"@site/docs/enums/headstartwp_core.LOGTYPE.md",sourceDirName:"enums",slug:"/enums/headstartwp_core.LOGTYPE",permalink:"/docs/api/enums/headstartwp_core.LOGTYPE",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.LOGTYPE",title:"Enumeration: LOGTYPE",sidebar_label:"@headstartwp/core.LOGTYPE",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/next.middlewares",permalink:"/docs/api/namespaces/headstartwp_next.middlewares"},next:{title:"@headstartwp/core.AbstractFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"}},s={},p=[{value:"Enumeration Members",id:"enumeration-members",level:2},{value:"DEBUG",id:"debug",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"ERROR",id:"error",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"INFO",id:"info",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"WARN",id:"warn",level:3},{value:"Defined in",id:"defined-in-3",level:4}],c={toc:p};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".LOGTYPE"),(0,a.kt)("h2",{id:"enumeration-members"},"Enumeration Members"),(0,a.kt)("h3",{id:"debug"},"DEBUG"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"DEBUG")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"0")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/log.ts#L3"},"packages/core/src/utils/log.ts:3")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"error"},"ERROR"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"ERROR")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"3")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/log.ts#L6"},"packages/core/src/utils/log.ts:6")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"info"},"INFO"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"INFO")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"1")),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/log.ts#L4"},"packages/core/src/utils/log.ts:4")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"warn"},"WARN"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"WARN")," = ",(0,a.kt)("inlineCode",{parentName:"p"},"2")),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/log.ts#L5"},"packages/core/src/utils/log.ts:5")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/966ac8d5.94ca5d02.js b/assets/js/966ac8d5.011a7cc7.js similarity index 94% rename from assets/js/966ac8d5.94ca5d02.js rename to assets/js/966ac8d5.011a7cc7.js index 2d0b0a7e4..acb0f8ac6 100644 --- a/assets/js/966ac8d5.94ca5d02.js +++ b/assets/js/966ac8d5.011a7cc7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2900],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>m});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),d=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},c=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),s=d(a),h=n,m=s["".concat(p,".").concat(h)]||s[h]||k[h]||i;return a?r.createElement(m,l(l({ref:t},c),{},{components:a})):r.createElement(m,l({ref:t},c))}));function m(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=h;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,l[1]=o;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.CoverBlockProps",title:"Interface: CoverBlockProps",sidebar_label:"@headstartwp/core.react.CoverBlockProps",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.CoverBlockProps",id:"interfaces/headstartwp_core.react.CoverBlockProps",title:"Interface: CoverBlockProps",description:"@headstartwp/core.react.CoverBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.CoverBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.CoverBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.CoverBlockProps",title:"Interface: CoverBlockProps",sidebar_label:"@headstartwp/core.react.CoverBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ColumnsBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps"},next:{title:"@headstartwp/core.react.FetchHookOptions",permalink:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"dimRatio",id:"dimratio",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"focalPoint",id:"focalpoint",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"hasParallax",id:"hasparallax",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"isDark",id:"isdark",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"isRepeated",id:"isrepeated",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"minHeight",id:"minheight",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"overlayColor",id:"overlaycolor",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-15",level:4}],c={toc:d};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".CoverBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"CoverBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"dimratio"},"dimRatio"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"dimRatio"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/CoverBlock.tsx#L12"},"packages/core/src/react/blocks/CoverBlock.tsx:12")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"focalpoint"},"focalPoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"focalPoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"x")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"number"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"y")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"number"))))),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/CoverBlock.tsx#L16"},"packages/core/src/react/blocks/CoverBlock.tsx:16")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"hasparallax"},"hasParallax"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"hasParallax"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/CoverBlock.tsx#L9"},"packages/core/src/react/blocks/CoverBlock.tsx:9")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"id"},"id"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"id"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/CoverBlock.tsx#L11"},"packages/core/src/react/blocks/CoverBlock.tsx:11")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"isdark"},"isDark"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isDark"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/CoverBlock.tsx#L13"},"packages/core/src/react/blocks/CoverBlock.tsx:13")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"isrepeated"},"isRepeated"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isRepeated"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/CoverBlock.tsx#L10"},"packages/core/src/react/blocks/CoverBlock.tsx:10")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"minheight"},"minHeight"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"minHeight"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/CoverBlock.tsx#L15"},"packages/core/src/react/blocks/CoverBlock.tsx:15")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"overlaycolor"},"overlayColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"overlayColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/CoverBlock.tsx#L8"},"packages/core/src/react/blocks/CoverBlock.tsx:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"url"},"url"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"url"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/CoverBlock.tsx#L14"},"packages/core/src/react/blocks/CoverBlock.tsx:14")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2900],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>m});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),d=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},c=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),s=d(a),h=n,m=s["".concat(p,".").concat(h)]||s[h]||k[h]||i;return a?r.createElement(m,l(l({ref:t},c),{},{components:a})):r.createElement(m,l({ref:t},c))}));function m(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=h;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,l[1]=o;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.CoverBlockProps",title:"Interface: CoverBlockProps",sidebar_label:"@headstartwp/core.react.CoverBlockProps",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.CoverBlockProps",id:"interfaces/headstartwp_core.react.CoverBlockProps",title:"Interface: CoverBlockProps",description:"@headstartwp/core.react.CoverBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.CoverBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.CoverBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.CoverBlockProps",title:"Interface: CoverBlockProps",sidebar_label:"@headstartwp/core.react.CoverBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ColumnsBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps"},next:{title:"@headstartwp/core.react.FetchHookOptions",permalink:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"dimRatio",id:"dimratio",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"focalPoint",id:"focalpoint",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"hasParallax",id:"hasparallax",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"isDark",id:"isdark",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"isRepeated",id:"isrepeated",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"minHeight",id:"minheight",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"overlayColor",id:"overlaycolor",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-15",level:4}],c={toc:d};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".CoverBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"CoverBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"dimratio"},"dimRatio"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"dimRatio"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/CoverBlock.tsx#L12"},"packages/core/src/react/blocks/CoverBlock.tsx:12")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"focalpoint"},"focalPoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"focalPoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"x")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"number"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"y")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"number"))))),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/CoverBlock.tsx#L16"},"packages/core/src/react/blocks/CoverBlock.tsx:16")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"hasparallax"},"hasParallax"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"hasParallax"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/CoverBlock.tsx#L9"},"packages/core/src/react/blocks/CoverBlock.tsx:9")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"id"},"id"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"id"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/CoverBlock.tsx#L11"},"packages/core/src/react/blocks/CoverBlock.tsx:11")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"isdark"},"isDark"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isDark"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/CoverBlock.tsx#L13"},"packages/core/src/react/blocks/CoverBlock.tsx:13")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"isrepeated"},"isRepeated"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isRepeated"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/CoverBlock.tsx#L10"},"packages/core/src/react/blocks/CoverBlock.tsx:10")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"minheight"},"minHeight"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"minHeight"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/CoverBlock.tsx#L15"},"packages/core/src/react/blocks/CoverBlock.tsx:15")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"overlaycolor"},"overlayColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"overlayColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/CoverBlock.tsx#L8"},"packages/core/src/react/blocks/CoverBlock.tsx:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"url"},"url"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"url"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/CoverBlock.tsx#L14"},"packages/core/src/react/blocks/CoverBlock.tsx:14")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/9689b62a.fa6ba3f6.js b/assets/js/9689b62a.044d4d01.js similarity index 82% rename from assets/js/9689b62a.fa6ba3f6.js rename to assets/js/9689b62a.044d4d01.js index 3e69d034b..f68ad31c1 100644 --- a/assets/js/9689b62a.fa6ba3f6.js +++ b/assets/js/9689b62a.044d4d01.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7244],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var c=n.createContext({}),p=function(e){var t=n.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},s=function(e){var t=p(e.components);return n.createElement(c.Provider,{value:t},e.children)},l="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,c=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),l=p(r),f=a,m=l["".concat(c,".").concat(f)]||l[f]||u[f]||o;return r?n.createElement(m,i(i({ref:t},s),{},{components:r})):n.createElement(m,i({ref:t},s))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=f;var d={};for(var c in t)hasOwnProperty.call(t,c)&&(d[c]=t[c]);d.originalType=e,d[l]="string"==typeof e?e:a,i[1]=d;for(var p=2;p{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>d,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const o={id:"headstartwp_core.Rendered",title:"Interface: Rendered",sidebar_label:"@headstartwp/core.Rendered",custom_edit_url:null},i=void 0,d={unversionedId:"interfaces/headstartwp_core.Rendered",id:"interfaces/headstartwp_core.Rendered",title:"Interface: Rendered",description:"@headstartwp/core.Rendered",source:"@site/docs/interfaces/headstartwp_core.Rendered.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.Rendered",permalink:"/docs/api/interfaces/headstartwp_core.Rendered",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.Rendered",title:"Interface: Rendered",sidebar_label:"@headstartwp/core.Rendered",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PostsArchiveParams",permalink:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},next:{title:"@headstartwp/core.RevisionEntity",permalink:"/docs/api/interfaces/headstartwp_core.RevisionEntity"}},c={},p=[{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"rendered",id:"rendered",level:3},{value:"Defined in",id:"defined-in",level:4}],s={toc:p};function l(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".Rendered"),(0,a.kt)("p",null,"Cover some cases of objects with ",(0,a.kt)("inlineCode",{parentName:"p"},"rendered")," property."),(0,a.kt)("h2",{id:"indexable"},"Indexable"),(0,a.kt)("p",null,"\u25aa ","[k: ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"rendered"},"rendered"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"rendered"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Property of the object, transformed for display."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L25"},"packages/core/src/data/types/entities.ts:25")))}l.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7244],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=n.createContext({}),c=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},s=function(e){var t=c(e.components);return n.createElement(p.Provider,{value:t},e.children)},l="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,p=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),l=c(r),f=a,m=l["".concat(p,".").concat(f)]||l[f]||u[f]||o;return r?n.createElement(m,i(i({ref:t},s),{},{components:r})):n.createElement(m,i({ref:t},s))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=f;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d[l]="string"==typeof e?e:a,i[1]=d;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>d,toc:()=>c});var n=r(7462),a=(r(7294),r(3905));const o={id:"headstartwp_core.Rendered",title:"Interface: Rendered",sidebar_label:"@headstartwp/core.Rendered",custom_edit_url:null},i=void 0,d={unversionedId:"interfaces/headstartwp_core.Rendered",id:"interfaces/headstartwp_core.Rendered",title:"Interface: Rendered",description:"@headstartwp/core.Rendered",source:"@site/docs/interfaces/headstartwp_core.Rendered.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.Rendered",permalink:"/docs/api/interfaces/headstartwp_core.Rendered",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.Rendered",title:"Interface: Rendered",sidebar_label:"@headstartwp/core.Rendered",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PostsArchiveParams",permalink:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},next:{title:"@headstartwp/core.RevisionEntity",permalink:"/docs/api/interfaces/headstartwp_core.RevisionEntity"}},p={},c=[{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"rendered",id:"rendered",level:3},{value:"Defined in",id:"defined-in",level:4}],s={toc:c};function l(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".Rendered"),(0,a.kt)("p",null,"Cover some cases of objects with ",(0,a.kt)("inlineCode",{parentName:"p"},"rendered")," property."),(0,a.kt)("h2",{id:"indexable"},"Indexable"),(0,a.kt)("p",null,"\u25aa ","[k: ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"rendered"},"rendered"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"rendered"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("p",null,"Property of the object, transformed for display."),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L25"},"packages/core/src/data/types/entities.ts:25")))}l.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/96b34eb5.6d718afd.js b/assets/js/96b34eb5.bb108b9a.js similarity index 91% rename from assets/js/96b34eb5.6d718afd.js rename to assets/js/96b34eb5.bb108b9a.js index a72a480df..5bcf64e55 100644 --- a/assets/js/96b34eb5.6d718afd.js +++ b/assets/js/96b34eb5.bb108b9a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9108],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),o=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},c=function(e){var t=o(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,c=d(e,["components","mdxType","originalType","parentName"]),s=o(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},c),{},{components:a})):r.createElement(h,l({ref:t},c))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var d={};for(var p in t)hasOwnProperty.call(t,p)&&(d[p]=t[p]);d.originalType=e,d[s]="string"==typeof e?e:n,l[1]=d;for(var o=2;o{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>d,toc:()=>o});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.MediaTextBlockProps",title:"Interface: MediaTextBlockProps",sidebar_label:"@headstartwp/core.react.MediaTextBlockProps",custom_edit_url:null},l=void 0,d={unversionedId:"interfaces/headstartwp_core.react.MediaTextBlockProps",id:"interfaces/headstartwp_core.react.MediaTextBlockProps",title:"Interface: MediaTextBlockProps",description:"@headstartwp/core.react.MediaTextBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.MediaTextBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.MediaTextBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.MediaTextBlockProps",title:"Interface: MediaTextBlockProps",sidebar_label:"@headstartwp/core.react.MediaTextBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ListBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps"},next:{title:"@headstartwp/core.react.ParagraphBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps"}},p={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"focalPoint",id:"focalpoint",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"imageFill",id:"imagefill",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"mediaId",id:"mediaid",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"mediaPosition",id:"mediaposition",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"mediaSizeSlug",id:"mediasizeslug",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"mediaType",id:"mediatype",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"mediaWidth",id:"mediawidth",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"verticalAlignment",id:"verticalalignment",level:3},{value:"Defined in",id:"defined-in-14",level:4}],c={toc:o};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".MediaTextBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"MediaTextBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"focalpoint"},"focalPoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"focalPoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"x")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"number"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"y")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"number"))))),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/MediaTextBlock.tsx#L13"},"packages/core/src/react/blocks/MediaTextBlock.tsx:13")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"imagefill"},"imageFill"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"imageFill"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/MediaTextBlock.tsx#L12"},"packages/core/src/react/blocks/MediaTextBlock.tsx:12")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"mediaid"},"mediaId"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"mediaId"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/MediaTextBlock.tsx#L8"},"packages/core/src/react/blocks/MediaTextBlock.tsx:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"mediaposition"},"mediaPosition"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"mediaPosition"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"left"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"right"')),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/MediaTextBlock.tsx#L7"},"packages/core/src/react/blocks/MediaTextBlock.tsx:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"mediasizeslug"},"mediaSizeSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"mediaSizeSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/MediaTextBlock.tsx#L10"},"packages/core/src/react/blocks/MediaTextBlock.tsx:10")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"mediatype"},"mediaType"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"mediaType"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"image"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"video"')),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/MediaTextBlock.tsx#L9"},"packages/core/src/react/blocks/MediaTextBlock.tsx:9")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"mediawidth"},"mediaWidth"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"mediaWidth"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/MediaTextBlock.tsx#L11"},"packages/core/src/react/blocks/MediaTextBlock.tsx:11")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"verticalalignment"},"verticalAlignment"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"verticalAlignment"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"center"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"top"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"bottom"')),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/MediaTextBlock.tsx#L17"},"packages/core/src/react/blocks/MediaTextBlock.tsx:17")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9108],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var d=r.createContext({}),o=function(e){var t=r.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},c=function(e){var t=o(e.components);return r.createElement(d.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,d=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),s=o(a),m=n,h=s["".concat(d,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},c),{},{components:a})):r.createElement(h,l({ref:t},c))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var p={};for(var d in t)hasOwnProperty.call(t,d)&&(p[d]=t[d]);p.originalType=e,p[s]="string"==typeof e?e:n,l[1]=p;for(var o=2;o{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>p,toc:()=>o});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.MediaTextBlockProps",title:"Interface: MediaTextBlockProps",sidebar_label:"@headstartwp/core.react.MediaTextBlockProps",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.react.MediaTextBlockProps",id:"interfaces/headstartwp_core.react.MediaTextBlockProps",title:"Interface: MediaTextBlockProps",description:"@headstartwp/core.react.MediaTextBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.MediaTextBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.MediaTextBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.MediaTextBlockProps",title:"Interface: MediaTextBlockProps",sidebar_label:"@headstartwp/core.react.MediaTextBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ListBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps"},next:{title:"@headstartwp/core.react.ParagraphBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps"}},d={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"focalPoint",id:"focalpoint",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"imageFill",id:"imagefill",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"mediaId",id:"mediaid",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"mediaPosition",id:"mediaposition",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"mediaSizeSlug",id:"mediasizeslug",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"mediaType",id:"mediatype",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"mediaWidth",id:"mediawidth",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"verticalAlignment",id:"verticalalignment",level:3},{value:"Defined in",id:"defined-in-14",level:4}],c={toc:o};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".MediaTextBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"MediaTextBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"focalpoint"},"focalPoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"focalPoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"x")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"number"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"y")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"number"))))),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/MediaTextBlock.tsx#L13"},"packages/core/src/react/blocks/MediaTextBlock.tsx:13")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"imagefill"},"imageFill"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"imageFill"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/MediaTextBlock.tsx#L12"},"packages/core/src/react/blocks/MediaTextBlock.tsx:12")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"mediaid"},"mediaId"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"mediaId"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/MediaTextBlock.tsx#L8"},"packages/core/src/react/blocks/MediaTextBlock.tsx:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"mediaposition"},"mediaPosition"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"mediaPosition"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"left"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"right"')),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/MediaTextBlock.tsx#L7"},"packages/core/src/react/blocks/MediaTextBlock.tsx:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"mediasizeslug"},"mediaSizeSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"mediaSizeSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/MediaTextBlock.tsx#L10"},"packages/core/src/react/blocks/MediaTextBlock.tsx:10")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"mediatype"},"mediaType"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"mediaType"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"image"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"video"')),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/MediaTextBlock.tsx#L9"},"packages/core/src/react/blocks/MediaTextBlock.tsx:9")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"mediawidth"},"mediaWidth"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"mediaWidth"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/MediaTextBlock.tsx#L11"},"packages/core/src/react/blocks/MediaTextBlock.tsx:11")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"verticalalignment"},"verticalAlignment"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"verticalAlignment"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"center"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"top"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"bottom"')),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/MediaTextBlock.tsx#L17"},"packages/core/src/react/blocks/MediaTextBlock.tsx:17")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/9818e328.ea417ae3.js b/assets/js/9818e328.7de2453c.js similarity index 88% rename from assets/js/9818e328.ea417ae3.js rename to assets/js/9818e328.7de2453c.js index 1c46854b9..921879149 100644 --- a/assets/js/9818e328.ea417ae3.js +++ b/assets/js/9818e328.7de2453c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8673],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>u});var n=a(7294);function i(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function d(e){for(var t=1;t=0||(i[a]=e[a]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var s=n.createContext({}),l=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):d(d({},t),e)),a},o=function(e){var t=l(e.components);return n.createElement(s.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var a=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,o=p(e,["components","mdxType","originalType","parentName"]),c=l(a),h=i,u=c["".concat(s,".").concat(h)]||c[h]||k[h]||r;return a?n.createElement(u,d(d({ref:t},o),{},{components:a})):n.createElement(u,d({ref:t},o))}));function u(e,t){var a=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=a.length,d=new Array(r);d[0]=h;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[c]="string"==typeof e?e:i,d[1]=p;for(var l=2;l{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>d,default:()=>c,frontMatter:()=>r,metadata:()=>p,toc:()=>l});var n=a(7462),i=(a(7294),a(3905));const r={id:"headstartwp_core.PostTypeEntity",title:"Interface: PostTypeEntity",sidebar_label:"@headstartwp/core.PostTypeEntity",custom_edit_url:null},d=void 0,p={unversionedId:"interfaces/headstartwp_core.PostTypeEntity",id:"interfaces/headstartwp_core.PostTypeEntity",title:"Interface: PostTypeEntity",description:"@headstartwp/core.PostTypeEntity",source:"@site/docs/interfaces/headstartwp_core.PostTypeEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PostTypeEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostTypeEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostTypeEntity",title:"Interface: PostTypeEntity",sidebar_label:"@headstartwp/core.PostTypeEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PostSearchEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"},next:{title:"@headstartwp/core.PostsArchiveParams",permalink:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embedded",id:"_embedded",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"author",id:"author",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"comment_status",id:"comment_status",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"date",id:"date",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"date_gmt",id:"date_gmt",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"guid",id:"guid",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"link",id:"link",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"modified",id:"modified",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"modified_gmt",id:"modified_gmt",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"ping_status",id:"ping_status",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"terms",id:"terms",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-17",level:4}],o={toc:l};function c(e){let{components:t,...a}=e;return(0,i.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostTypeEntity"),(0,i.kt)("p",null,"Base interface for all post type entities."),(0,i.kt)("p",null,"Interfaces that extends from this one are:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},"PostEntity"),"."),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PageEntity"},"PageEntity"),"."),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.AttachmentEntity"},"AttachmentEntity"),"."),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.RevisionEntity"},"RevisionEntity"),".")),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,i.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"PostTypeEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"PostEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.RevisionEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"RevisionEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"PageEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AttachmentEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AttachmentEntity"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"_embedded"},"_","embedded"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"_","embedded"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"author")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wp:term")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]")))),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L98"},"packages/core/src/data/types/entities.ts:98")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"author"},"author"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"author"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L94"},"packages/core/src/data/types/entities.ts:94")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"comment_status"},"comment","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"comment","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not comments are open on the object."),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L106"},"packages/core/src/data/types/entities.ts:106")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date"},"date"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, in the site's timezone."),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L42"},"packages/core/src/data/types/entities.ts:42")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date_gmt"},"date","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, as GMT."),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L47"},"packages/core/src/data/types/entities.ts:47")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"guid"},"guid"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"guid"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The globally unique identifier for the object."),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L52"},"packages/core/src/data/types/entities.ts:52")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"id"},"id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Unique identifier for the object."),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L67"},"packages/core/src/data/types/entities.ts:67")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"link"},"link"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"link"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"URL to the object."),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L72"},"packages/core/src/data/types/entities.ts:72")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified"},"modified"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, in the site's timezone."),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L57"},"packages/core/src/data/types/entities.ts:57")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified_gmt"},"modified","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, as GMT."),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L62"},"packages/core/src/data/types/entities.ts:62")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ping_status"},"ping","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ping","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not the object can be pinged."),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L111"},"packages/core/src/data/types/entities.ts:111")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"slug"},"slug"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"slug"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"An alphanumeric identifier for the object unique to its type."),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L77"},"packages/core/src/data/types/entities.ts:77")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"status"},"status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"publish"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"future"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"draft"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"pending"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"private"')),(0,i.kt)("p",null,"A named status for the object."),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L82"},"packages/core/src/data/types/entities.ts:82")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"terms"},"terms"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"terms"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L96"},"packages/core/src/data/types/entities.ts:96")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The title for the object."),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L92"},"packages/core/src/data/types/entities.ts:92")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"type"},"type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Type of Post for the object."),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L87"},"packages/core/src/data/types/entities.ts:87")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L114"},"packages/core/src/data/types/entities.ts:114")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("h4",{id:"overrides-1"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L113"},"packages/core/src/data/types/entities.ts:113")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8673],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>u});var n=a(7294);function i(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(i[a]=e[a]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var s=n.createContext({}),l=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=l(e.components);return n.createElement(s.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var a=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),c=l(a),h=i,u=c["".concat(s,".").concat(h)]||c[h]||k[h]||r;return a?n.createElement(u,p(p({ref:t},o),{},{components:a})):n.createElement(u,p({ref:t},o))}));function u(e,t){var a=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=a.length,p=new Array(r);p[0]=h;var d={};for(var s in t)hasOwnProperty.call(t,s)&&(d[s]=t[s]);d.originalType=e,d[c]="string"==typeof e?e:i,p[1]=d;for(var l=2;l{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>c,frontMatter:()=>r,metadata:()=>d,toc:()=>l});var n=a(7462),i=(a(7294),a(3905));const r={id:"headstartwp_core.PostTypeEntity",title:"Interface: PostTypeEntity",sidebar_label:"@headstartwp/core.PostTypeEntity",custom_edit_url:null},p=void 0,d={unversionedId:"interfaces/headstartwp_core.PostTypeEntity",id:"interfaces/headstartwp_core.PostTypeEntity",title:"Interface: PostTypeEntity",description:"@headstartwp/core.PostTypeEntity",source:"@site/docs/interfaces/headstartwp_core.PostTypeEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PostTypeEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostTypeEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostTypeEntity",title:"Interface: PostTypeEntity",sidebar_label:"@headstartwp/core.PostTypeEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PostSearchEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"},next:{title:"@headstartwp/core.PostsArchiveParams",permalink:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embedded",id:"_embedded",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"author",id:"author",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"comment_status",id:"comment_status",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"date",id:"date",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"date_gmt",id:"date_gmt",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"guid",id:"guid",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"link",id:"link",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"modified",id:"modified",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"modified_gmt",id:"modified_gmt",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"ping_status",id:"ping_status",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"terms",id:"terms",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-17",level:4}],o={toc:l};function c(e){let{components:t,...a}=e;return(0,i.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostTypeEntity"),(0,i.kt)("p",null,"Base interface for all post type entities."),(0,i.kt)("p",null,"Interfaces that extends from this one are:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},"PostEntity"),"."),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.PageEntity"},"PageEntity"),"."),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.AttachmentEntity"},"AttachmentEntity"),"."),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/docs/api/interfaces/headstartwp_core.RevisionEntity"},"RevisionEntity"),".")),(0,i.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,i.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3 ",(0,i.kt)("strong",{parentName:"p"},(0,i.kt)("inlineCode",{parentName:"strong"},"PostTypeEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"PostEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.RevisionEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"RevisionEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"PageEntity"))),(0,i.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AttachmentEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AttachmentEntity"))))),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"_embedded"},"_","embedded"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"_","embedded"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Object")),(0,i.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"author")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"wp:term")),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[][]")))),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L98"},"packages/core/src/data/types/entities.ts:98")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"author"},"author"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"author"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"AuthorEntity")),"[]"),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L94"},"packages/core/src/data/types/entities.ts:94")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"comment_status"},"comment","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"comment","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not comments are open on the object."),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L106"},"packages/core/src/data/types/entities.ts:106")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date"},"date"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, in the site's timezone."),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L42"},"packages/core/src/data/types/entities.ts:42")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"date_gmt"},"date","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"date","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was published, as GMT."),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L47"},"packages/core/src/data/types/entities.ts:47")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"guid"},"guid"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"guid"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The globally unique identifier for the object."),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L52"},"packages/core/src/data/types/entities.ts:52")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"id"},"id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("p",null,"Unique identifier for the object."),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L67"},"packages/core/src/data/types/entities.ts:67")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"link"},"link"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"link"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"URL to the object."),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L72"},"packages/core/src/data/types/entities.ts:72")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified"},"modified"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, in the site's timezone."),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L57"},"packages/core/src/data/types/entities.ts:57")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"modified_gmt"},"modified","_","gmt"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"modified","_","gmt"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"The date the object was last modified, as GMT."),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L62"},"packages/core/src/data/types/entities.ts:62")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"ping_status"},"ping","_","status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ping","_","status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"open"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"closed"')),(0,i.kt)("p",null,"Whether or not the object can be pinged."),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L111"},"packages/core/src/data/types/entities.ts:111")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"slug"},"slug"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"slug"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"An alphanumeric identifier for the object unique to its type."),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L77"},"packages/core/src/data/types/entities.ts:77")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"status"},"status"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"status"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"publish"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"future"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"draft"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"pending"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"private"')),(0,i.kt)("p",null,"A named status for the object."),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L82"},"packages/core/src/data/types/entities.ts:82")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"terms"},"terms"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"terms"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]",">"),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L96"},"packages/core/src/data/types/entities.ts:96")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,i.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,i.kt)("p",null,"The title for the object."),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L92"},"packages/core/src/data/types/entities.ts:92")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"type"},"type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("p",null,"Type of Post for the object."),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L87"},"packages/core/src/data/types/entities.ts:87")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"overrides"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L114"},"packages/core/src/data/types/entities.ts:114")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,i.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,i.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,i.kt)("h4",{id:"overrides-1"},"Overrides"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L113"},"packages/core/src/data/types/entities.ts:113")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/99fcc669.2d45ac6c.js b/assets/js/99fcc669.4a2c0c47.js similarity index 99% rename from assets/js/99fcc669.2d45ac6c.js rename to assets/js/99fcc669.4a2c0c47.js index c803adab2..51f52cf59 100644 --- a/assets/js/99fcc669.2d45ac6c.js +++ b/assets/js/99fcc669.4a2c0c47.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8115],{3905:(e,t,r)=>{r.d(t,{Zo:()=>h,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var u=n.createContext({}),c=function(e){var t=n.useContext(u),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},h=function(e){var t=c(e.components);return n.createElement(u.Provider,{value:t},e.children)},p="mdxType",l={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,u=e.parentName,h=s(e,["components","mdxType","originalType","parentName"]),p=c(r),d=a,m=p["".concat(u,".").concat(d)]||p[d]||l[d]||o;return r?n.createElement(m,i(i({ref:t},h),{},{components:r})):n.createElement(m,i({ref:t},h))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=d;var s={};for(var u in t)hasOwnProperty.call(t,u)&&(s[u]=t[u]);s.originalType=e,s[p]="string"==typeof e?e:a,i[1]=s;for(var c=2;c{r.r(t),r.d(t,{assets:()=>u,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>s,toc:()=>c});var n=r(7462),a=(r(7294),r(3905));const o={slug:"/data-fetching/useauthorarchive",sidebar_position:3},i="The useAuthorArchive Hook",s={unversionedId:"Data Fetching/useAuthorArchive",id:"Data Fetching/useAuthorArchive",title:"The useAuthorArchive Hook",description:"The useAuthorArchive hook is the Next.js binding for the useFetchAuthorArchive.",source:"@site/documentation/02 - Data Fetching/useAuthorArchive.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/useauthorarchive",permalink:"/docs/learn/data-fetching/useauthorarchive",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/useAuthorArchive.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",sidebarPosition:3,frontMatter:{slug:"/data-fetching/useauthorarchive",sidebar_position:3},sidebar:"tutorialSidebar",previous:{title:"The usePosts hook",permalink:"/docs/learn/data-fetching/useposts"},next:{title:"The usePostOrPosts hook",permalink:"/docs/learn/data-fetching/use-post-or-posts"}},u={},c=[{value:"Basic Usage (Author Archive)",id:"basic-usage-author-archive",level:2},{value:"Author Archive for Custom Post Type",id:"author-archive-for-custom-post-type",level:2}],h={toc:c};function p(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},h,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"the-useauthorarchive-hook"},"The useAuthorArchive Hook"),(0,a.kt)("blockquote",null,(0,a.kt)("p",{parentName:"blockquote"},"The ",(0,a.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next#useauthorarchive"},"useAuthorArchive")," hook is the Next.js binding for the ",(0,a.kt)("a",{parentName:"p",href:"/api/namespaces/headstartwp_core.react#usefetchauthorarchive"},"useFetchAuthorArchive"),".")),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"useAuthorArchive")," hook fetches a collection of WordPress posts from a registered post type filtered by an author."),(0,a.kt)("h2",{id:"basic-usage-author-archive"},"Basic Usage (Author Archive)"),(0,a.kt)("p",null,"Assuming a ",(0,a.kt)("inlineCode",{parentName:"p"},"src/pages/author/[...path].js")," route with the following content."),(0,a.kt)("admonition",{type:"info"},(0,a.kt)("p",{parentName:"admonition"},"This example is using the catch-all route ",(0,a.kt)("inlineCode",{parentName:"p"},"[..path].js")," because ",(0,a.kt)("strong",{parentName:"p"},"we do not want")," the ",(0,a.kt)("inlineCode",{parentName:"p"},"/author")," path to be handled by this route.")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/author/[...path].js"',title:'"src/pages/author/[...path].js"'},"import { useAuthorArchive } from '@headstartwp/next';\n\nconst ArchivePage = () => {\n const { loading, error, data } = useAuthorArchive({ per_page: 10 });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n {data?.posts?.map((post) => (\n

{post.title.rendered}

\n ))}\n
\n );\n};\n")),(0,a.kt)("p",null,"The route will automatically render the latest 10 posts from the current author. The following paths will automatically be handled by the hook."),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"/author/author-name"),(0,a.kt)("li",{parentName:"ul"},"/author/author-name/page/2")),(0,a.kt)("h2",{id:"author-archive-for-custom-post-type"},"Author Archive for Custom Post Type"),(0,a.kt)("p",null,"In order to fetch posts from a custom post type, first declare the custom post type in ",(0,a.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," as explained in the ",(0,a.kt)("a",{parentName:"p",href:"/learn/getting-started/headless-config#custom-post-types"},"headstartwp.config.js")," section. "),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/author/[...path].js"',title:'"src/pages/author/[...path].js"'},"import { useAuthorArchive } from '@headstartwp/next';\n\nconst ArchivePage = () => {\n // book must be declared in headstartwp.config.js\n const { loading, error, data } = useAuthorArchive({ postType: ['book'] });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n {data?.posts?.map((post) => (\n

{post.title.rendered}

\n ))}\n
\n );\n};\n")))}p.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8115],{3905:(e,t,r)=>{r.d(t,{Zo:()=>h,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var u=n.createContext({}),c=function(e){var t=n.useContext(u),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},h=function(e){var t=c(e.components);return n.createElement(u.Provider,{value:t},e.children)},p="mdxType",l={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,u=e.parentName,h=s(e,["components","mdxType","originalType","parentName"]),p=c(r),d=a,m=p["".concat(u,".").concat(d)]||p[d]||l[d]||o;return r?n.createElement(m,i(i({ref:t},h),{},{components:r})):n.createElement(m,i({ref:t},h))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=d;var s={};for(var u in t)hasOwnProperty.call(t,u)&&(s[u]=t[u]);s.originalType=e,s[p]="string"==typeof e?e:a,i[1]=s;for(var c=2;c{r.r(t),r.d(t,{assets:()=>u,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>s,toc:()=>c});var n=r(7462),a=(r(7294),r(3905));const o={slug:"/data-fetching/useauthorarchive",sidebar_position:3},i="The useAuthorArchive Hook",s={unversionedId:"Data Fetching/useAuthorArchive",id:"Data Fetching/useAuthorArchive",title:"The useAuthorArchive Hook",description:"The useAuthorArchive hook is the Next.js binding for the useFetchAuthorArchive.",source:"@site/documentation/02 - Data Fetching/useAuthorArchive.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/useauthorarchive",permalink:"/docs/learn/data-fetching/useauthorarchive",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/useAuthorArchive.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",sidebarPosition:3,frontMatter:{slug:"/data-fetching/useauthorarchive",sidebar_position:3},sidebar:"tutorialSidebar",previous:{title:"The usePosts hook",permalink:"/docs/learn/data-fetching/useposts"},next:{title:"The usePostOrPosts hook",permalink:"/docs/learn/data-fetching/use-post-or-posts"}},u={},c=[{value:"Basic Usage (Author Archive)",id:"basic-usage-author-archive",level:2},{value:"Author Archive for Custom Post Type",id:"author-archive-for-custom-post-type",level:2}],h={toc:c};function p(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},h,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"the-useauthorarchive-hook"},"The useAuthorArchive Hook"),(0,a.kt)("blockquote",null,(0,a.kt)("p",{parentName:"blockquote"},"The ",(0,a.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next#useauthorarchive"},"useAuthorArchive")," hook is the Next.js binding for the ",(0,a.kt)("a",{parentName:"p",href:"/api/namespaces/headstartwp_core.react#usefetchauthorarchive"},"useFetchAuthorArchive"),".")),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"useAuthorArchive")," hook fetches a collection of WordPress posts from a registered post type filtered by an author."),(0,a.kt)("h2",{id:"basic-usage-author-archive"},"Basic Usage (Author Archive)"),(0,a.kt)("p",null,"Assuming a ",(0,a.kt)("inlineCode",{parentName:"p"},"src/pages/author/[...path].js")," route with the following content."),(0,a.kt)("admonition",{type:"info"},(0,a.kt)("p",{parentName:"admonition"},"This example is using the catch-all route ",(0,a.kt)("inlineCode",{parentName:"p"},"[..path].js")," because ",(0,a.kt)("strong",{parentName:"p"},"we do not want")," the ",(0,a.kt)("inlineCode",{parentName:"p"},"/author")," path to be handled by this route.")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/author/[...path].js"',title:'"src/pages/author/[...path].js"'},"import { useAuthorArchive } from '@headstartwp/next';\n\nconst ArchivePage = () => {\n const { loading, error, data } = useAuthorArchive({ per_page: 10 });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n {data?.posts?.map((post) => (\n

{post.title.rendered}

\n ))}\n
\n );\n};\n")),(0,a.kt)("p",null,"The route will automatically render the latest 10 posts from the current author. The following paths will automatically be handled by the hook."),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"/author/author-name"),(0,a.kt)("li",{parentName:"ul"},"/author/author-name/page/2")),(0,a.kt)("h2",{id:"author-archive-for-custom-post-type"},"Author Archive for Custom Post Type"),(0,a.kt)("p",null,"In order to fetch posts from a custom post type, first declare the custom post type in ",(0,a.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," as explained in the ",(0,a.kt)("a",{parentName:"p",href:"/learn/getting-started/headless-config#custom-post-types"},"headstartwp.config.js")," section. "),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/author/[...path].js"',title:'"src/pages/author/[...path].js"'},"import { useAuthorArchive } from '@headstartwp/next';\n\nconst ArchivePage = () => {\n // book must be declared in headstartwp.config.js\n const { loading, error, data } = useAuthorArchive({ postType: ['book'] });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n {data?.posts?.map((post) => (\n

{post.title.rendered}

\n ))}\n
\n );\n};\n")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/9be33a19.257bfba6.js b/assets/js/9be33a19.994205e7.js similarity index 96% rename from assets/js/9be33a19.257bfba6.js rename to assets/js/9be33a19.994205e7.js index 519541133..f674ee6f2 100644 --- a/assets/js/9be33a19.257bfba6.js +++ b/assets/js/9be33a19.994205e7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3131],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function p(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var l=a.createContext({}),c=function(e){var t=a.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):p(p({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(l.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,l=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(r),m=n,h=s["".concat(l,".").concat(m)]||s[m]||k[m]||i;return r?a.createElement(h,p(p({ref:t},d),{},{components:r})):a.createElement(h,p({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,p=new Array(i);p[0]=m;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o[s]="string"==typeof e?e:n,p[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.SeparatorBlockProps",title:"Interface: SeparatorBlockProps",sidebar_label:"@headstartwp/core.react.SeparatorBlockProps",custom_edit_url:null},p=void 0,o={unversionedId:"interfaces/headstartwp_core.react.SeparatorBlockProps",id:"interfaces/headstartwp_core.react.SeparatorBlockProps",title:"Interface: SeparatorBlockProps",description:"@headstartwp/core.react.SeparatorBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.SeparatorBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.SeparatorBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.SeparatorBlockProps",title:"Interface: SeparatorBlockProps",sidebar_label:"@headstartwp/core.react.SeparatorBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.SafeHtmlProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SafeHtmlProps"},next:{title:"@headstartwp/core.react.SettingsCustomAdditionalProperties",permalink:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties"}},l={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".SeparatorBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"SeparatorBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3131],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function p(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var l=a.createContext({}),c=function(e){var t=a.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):p(p({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(l.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,l=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(r),m=n,h=s["".concat(l,".").concat(m)]||s[m]||k[m]||i;return r?a.createElement(h,p(p({ref:t},d),{},{components:r})):a.createElement(h,p({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,p=new Array(i);p[0]=m;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o[s]="string"==typeof e?e:n,p[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.SeparatorBlockProps",title:"Interface: SeparatorBlockProps",sidebar_label:"@headstartwp/core.react.SeparatorBlockProps",custom_edit_url:null},p=void 0,o={unversionedId:"interfaces/headstartwp_core.react.SeparatorBlockProps",id:"interfaces/headstartwp_core.react.SeparatorBlockProps",title:"Interface: SeparatorBlockProps",description:"@headstartwp/core.react.SeparatorBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.SeparatorBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.SeparatorBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.SeparatorBlockProps",title:"Interface: SeparatorBlockProps",sidebar_label:"@headstartwp/core.react.SeparatorBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.SafeHtmlProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SafeHtmlProps"},next:{title:"@headstartwp/core.react.SettingsCustomAdditionalProperties",permalink:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties"}},l={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".SeparatorBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"SeparatorBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/9c66ae8c.01b07720.js b/assets/js/9c66ae8c.3dd0aa13.js similarity index 99% rename from assets/js/9c66ae8c.01b07720.js rename to assets/js/9c66ae8c.3dd0aa13.js index 929d922f9..6156ba99f 100644 --- a/assets/js/9c66ae8c.01b07720.js +++ b/assets/js/9c66ae8c.3dd0aa13.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1736],{3905:(e,t,a)=>{a.d(t,{Zo:()=>l,kt:()=>N});var p=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);t&&(p=p.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,p)}return a}function o(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(p=0;p=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var i=p.createContext({}),m=function(e){var t=p.useContext(i),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},l=function(e){var t=m(e.components);return p.createElement(i.Provider,{value:t},e.children)},c="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return p.createElement(p.Fragment,{},t)}},k=p.forwardRef((function(e,t){var a=e.components,n=e.mdxType,r=e.originalType,i=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),c=m(a),k=n,N=c["".concat(i,".").concat(k)]||c[k]||d[k]||r;return a?p.createElement(N,o(o({ref:t},l),{},{components:a})):p.createElement(N,o({ref:t},l))}));function N(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var r=a.length,o=new Array(r);o[0]=k;var s={};for(var i in t)hasOwnProperty.call(t,i)&&(s[i]=t[i]);s.originalType=e,s[c]="string"==typeof e?e:n,o[1]=s;for(var m=2;m{a.r(t),a.d(t,{assets:()=>i,contentTitle:()=>o,default:()=>c,frontMatter:()=>r,metadata:()=>s,toc:()=>m});var p=a(7462),n=(a(7294),a(3905));const r={id:"headstartwp_core.react.WpThemeJSON",title:"Interface: WpThemeJSON",sidebar_label:"@headstartwp/core.react.WpThemeJSON",custom_edit_url:null},o=void 0,s={unversionedId:"interfaces/headstartwp_core.react.WpThemeJSON",id:"interfaces/headstartwp_core.react.WpThemeJSON",title:"Interface: WpThemeJSON",description:"@headstartwp/core.react.WpThemeJSON",source:"@site/docs/interfaces/headstartwp_core.react.WpThemeJSON.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.WpThemeJSON",permalink:"/docs/api/interfaces/headstartwp_core.react.WpThemeJSON",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.WpThemeJSON",title:"Interface: WpThemeJSON",sidebar_label:"@headstartwp/core.react.WpThemeJSON",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.VerseBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps"},next:{title:"@headstartwp/core.react.YoutubeLiteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps"}},i={},m=[{value:"Properties",id:"properties",level:2},{value:"$schema",id:"schema",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"customTemplates",id:"customtemplates",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"settings",id:"settings",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"styles",id:"styles",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"templateParts",id:"templateparts",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"version",id:"version",level:3},{value:"Defined in",id:"defined-in-5",level:4}],l={toc:m};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,p.Z)({},l,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".WpThemeJSON"),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"schema"},"$schema"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"$schema"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"JSON schema URI for theme.json."),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L99"},"packages/core/src/react/provider/types.ts:99")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"customtemplates"},"customTemplates"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"customTemplates"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"postTypes?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[] ; ",(0,n.kt)("inlineCode",{parentName:"p"},"title"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," }[]"),(0,n.kt)("p",null,"Additional metadata for custom templates defined in the templates folder."),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L319"},"packages/core/src/react/provider/types.ts:319")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"settings"},"settings"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"settings"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsProperties"))," & { ",(0,n.kt)("inlineCode",{parentName:"p"},"blocks?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"core/archives?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/audio?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/block?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/button?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/buttons?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/calendar?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/categories?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/code?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/column?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/columns?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-author-avatar?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-author-name?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-content?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-date?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-edit-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-reply-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-template?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comments-query-loop?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/cover?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/embed?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/file?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/freeform?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/gallery?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/group?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/heading?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/home-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/html?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/image?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/latest-comments?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/latest-posts?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/legacy-widget?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/list?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/loginout?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/media-text?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/missing?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/more?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/navigation?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/navigation-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/nextpage?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/page-list?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/paragraph?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-author?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments-count?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments-form?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-content?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-date?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-excerpt?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-featured-image?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-navigation-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-template?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-terms?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-title?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/preformatted?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/pullquote?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination-next?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination-numbers?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination-previous?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-title?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/quote?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/rss?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/search?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/separator?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/shortcode?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/site-logo?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/site-tagline?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/site-title?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/social-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/social-links?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/spacer?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/table?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/table-of-contents?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/tag-cloud?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/template-part?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/term-description?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/text-columns?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/verse?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/video?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/widget-area?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/widget-group?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"border?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"radius?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"style?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"width?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"color?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"background?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"custom?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"customDuotone?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"customGradient?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultGradients?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultPalette?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"duotone?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingsduotone"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsDuotone"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"gradients?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingsgradient"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsGradient"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"link?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"palette?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingscolorpalette"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsColorPalette"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"text?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"custom?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"[k: string]"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsCustomAdditionalProperties")),"; } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"layout?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"contentSize?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"wideSize?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"spacing?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"blockGap?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"margin?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"padding?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"units?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[] } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"typography?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"customFontSize?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"dropCap?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"fontFamilies?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"fontFamily?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"name?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"slug?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," }[] ; ",(0,n.kt)("inlineCode",{parentName:"p"},"fontSizes?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"name?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"size?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"slug?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," }[] ; ",(0,n.kt)("inlineCode",{parentName:"p"},"fontStyle?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"fontWeight?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"letterSpacing?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"lineHeight?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"textDecoration?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"textTransform?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," } }"),(0,n.kt)("p",null,"Settings for the block editor and individual blocks. These include things like:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"Which customization options should be available to the user."),(0,n.kt)("li",{parentName:"ul"},"The default colors, font sizes... available to the user."),(0,n.kt)("li",{parentName:"ul"},"CSS custom properties and class names used in styles."),(0,n.kt)("li",{parentName:"ul"},"And the default layout of the editor (widths and available alignments).")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L111"},"packages/core/src/react/provider/types.ts:111")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"styles"},"styles"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"styles"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesProperties"))," & { ",(0,n.kt)("inlineCode",{parentName:"p"},"blocks?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"core/archives?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/audio?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/block?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/button?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/buttons?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/calendar?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/categories?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/code?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/column?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/columns?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-author-avatar?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-author-name?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-content?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-date?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-edit-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-reply-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-template?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comments-query-loop?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/cover?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/embed?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/file?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/freeform?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/gallery?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/group?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/heading?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/home-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/html?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/image?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/latest-comments?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/latest-posts?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/legacy-widget?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/list?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/loginout?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/media-text?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/missing?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/more?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/navigation?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/navigation-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/nextpage?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/page-list?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/paragraph?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-author?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments-count?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments-form?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-content?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-date?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-excerpt?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-featured-image?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-navigation-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-template?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-terms?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-title?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/preformatted?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/pullquote?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination-next?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination-numbers?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination-previous?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-title?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/quote?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/rss?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/search?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/separator?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/shortcode?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/site-logo?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/site-tagline?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/site-title?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/social-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/social-links?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/spacer?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/table?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/table-of-contents?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/tag-cloud?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/template-part?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/term-description?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/text-columns?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/verse?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/video?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/widget-area?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/widget-group?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"border?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"elements?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"h1?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"h2?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"h3?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"h4?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"h5?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"h6?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"spacing?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"typography?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")," }"),(0,n.kt)("p",null,"Organized way to set CSS properties. Styles in the top-level will be added in the ",(0,n.kt)("inlineCode",{parentName:"p"},"body")," selector."),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L210"},"packages/core/src/react/provider/types.ts:210")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"templateparts"},"templateParts"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"templateParts"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"area?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"title?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," }[]"),(0,n.kt)("p",null,"Additional metadata for template parts defined in the parts folder."),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L336"},"packages/core/src/react/provider/types.ts:336")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"version"},"version"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"version"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"2")),(0,n.kt)("p",null,"Version of theme.json to use."),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/provider/types.ts#L103"},"packages/core/src/react/provider/types.ts:103")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1736],{3905:(e,t,a)=>{a.d(t,{Zo:()=>l,kt:()=>N});var p=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);t&&(p=p.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,p)}return a}function o(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(p=0;p=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var i=p.createContext({}),m=function(e){var t=p.useContext(i),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},l=function(e){var t=m(e.components);return p.createElement(i.Provider,{value:t},e.children)},c="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return p.createElement(p.Fragment,{},t)}},k=p.forwardRef((function(e,t){var a=e.components,n=e.mdxType,r=e.originalType,i=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),c=m(a),k=n,N=c["".concat(i,".").concat(k)]||c[k]||d[k]||r;return a?p.createElement(N,o(o({ref:t},l),{},{components:a})):p.createElement(N,o({ref:t},l))}));function N(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var r=a.length,o=new Array(r);o[0]=k;var s={};for(var i in t)hasOwnProperty.call(t,i)&&(s[i]=t[i]);s.originalType=e,s[c]="string"==typeof e?e:n,o[1]=s;for(var m=2;m{a.r(t),a.d(t,{assets:()=>i,contentTitle:()=>o,default:()=>c,frontMatter:()=>r,metadata:()=>s,toc:()=>m});var p=a(7462),n=(a(7294),a(3905));const r={id:"headstartwp_core.react.WpThemeJSON",title:"Interface: WpThemeJSON",sidebar_label:"@headstartwp/core.react.WpThemeJSON",custom_edit_url:null},o=void 0,s={unversionedId:"interfaces/headstartwp_core.react.WpThemeJSON",id:"interfaces/headstartwp_core.react.WpThemeJSON",title:"Interface: WpThemeJSON",description:"@headstartwp/core.react.WpThemeJSON",source:"@site/docs/interfaces/headstartwp_core.react.WpThemeJSON.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.WpThemeJSON",permalink:"/docs/api/interfaces/headstartwp_core.react.WpThemeJSON",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.WpThemeJSON",title:"Interface: WpThemeJSON",sidebar_label:"@headstartwp/core.react.WpThemeJSON",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.VerseBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps"},next:{title:"@headstartwp/core.react.YoutubeLiteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps"}},i={},m=[{value:"Properties",id:"properties",level:2},{value:"$schema",id:"schema",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"customTemplates",id:"customtemplates",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"settings",id:"settings",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"styles",id:"styles",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"templateParts",id:"templateparts",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"version",id:"version",level:3},{value:"Defined in",id:"defined-in-5",level:4}],l={toc:m};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,p.Z)({},l,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".WpThemeJSON"),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"schema"},"$schema"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"$schema"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"JSON schema URI for theme.json."),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L99"},"packages/core/src/react/provider/types.ts:99")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"customtemplates"},"customTemplates"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"customTemplates"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"postTypes?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[] ; ",(0,n.kt)("inlineCode",{parentName:"p"},"title"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," }[]"),(0,n.kt)("p",null,"Additional metadata for custom templates defined in the templates folder."),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L319"},"packages/core/src/react/provider/types.ts:319")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"settings"},"settings"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"settings"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsProperties"))," & { ",(0,n.kt)("inlineCode",{parentName:"p"},"blocks?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"core/archives?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/audio?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/block?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/button?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/buttons?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/calendar?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/categories?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/code?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/column?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/columns?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-author-avatar?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-author-name?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-content?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-date?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-edit-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-reply-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-template?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comments-query-loop?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/cover?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/embed?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/file?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/freeform?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/gallery?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/group?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/heading?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/home-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/html?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/image?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/latest-comments?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/latest-posts?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/legacy-widget?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/list?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/loginout?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/media-text?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/missing?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/more?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/navigation?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/navigation-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/nextpage?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/page-list?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/paragraph?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-author?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments-count?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments-form?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-content?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-date?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-excerpt?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-featured-image?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-navigation-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-template?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-terms?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-title?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/preformatted?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/pullquote?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination-next?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination-numbers?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination-previous?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-title?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/quote?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/rss?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/search?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/separator?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/shortcode?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/site-logo?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/site-tagline?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/site-title?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/social-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/social-links?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/spacer?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/table?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/table-of-contents?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/tag-cloud?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/template-part?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/term-description?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/text-columns?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/verse?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/video?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/widget-area?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/widget-group?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingspropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsPropertiesComplete"))," } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"border?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"radius?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"style?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"width?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"color?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"background?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"custom?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"customDuotone?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"customGradient?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultGradients?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultPalette?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"duotone?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingsduotone"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsDuotone"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"gradients?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingsgradient"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsGradient"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"link?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"palette?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#settingscolorpalette"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsColorPalette"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"text?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"custom?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"[k: string]"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"number")," ","|"," ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties"},(0,n.kt)("inlineCode",{parentName:"a"},"SettingsCustomAdditionalProperties")),"; } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"layout?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"contentSize?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"wideSize?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"spacing?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"blockGap?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"margin?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"padding?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"units?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[] } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"typography?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"customFontSize?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"dropCap?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"fontFamilies?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"fontFamily?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"name?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"slug?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," }[] ; ",(0,n.kt)("inlineCode",{parentName:"p"},"fontSizes?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"name?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"size?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"slug?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," }[] ; ",(0,n.kt)("inlineCode",{parentName:"p"},"fontStyle?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"fontWeight?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"letterSpacing?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"lineHeight?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"textDecoration?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"textTransform?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")," } }"),(0,n.kt)("p",null,"Settings for the block editor and individual blocks. These include things like:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"Which customization options should be available to the user."),(0,n.kt)("li",{parentName:"ul"},"The default colors, font sizes... available to the user."),(0,n.kt)("li",{parentName:"ul"},"CSS custom properties and class names used in styles."),(0,n.kt)("li",{parentName:"ul"},"And the default layout of the editor (widths and available alignments).")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L111"},"packages/core/src/react/provider/types.ts:111")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"styles"},"styles"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"styles"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesProperties"))," & { ",(0,n.kt)("inlineCode",{parentName:"p"},"blocks?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"core/archives?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/audio?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/block?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/button?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/buttons?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/calendar?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/categories?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/code?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/column?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/columns?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-author-avatar?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-author-name?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-content?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-date?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-edit-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-reply-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comment-template?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/comments-query-loop?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/cover?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/embed?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/file?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/freeform?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/gallery?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/group?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/heading?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/home-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/html?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/image?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/latest-comments?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/latest-posts?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/legacy-widget?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/list?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/loginout?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/media-text?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/missing?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/more?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/navigation?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/navigation-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/nextpage?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/page-list?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/paragraph?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-author?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments-count?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments-form?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-comments-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-content?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-date?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-excerpt?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-featured-image?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-navigation-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-template?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-terms?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/post-title?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/preformatted?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/pullquote?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination-next?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination-numbers?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-pagination-previous?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/query-title?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/quote?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/rss?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/search?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/separator?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/shortcode?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/site-logo?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/site-tagline?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/site-title?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/social-link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/social-links?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/spacer?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/table?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/table-of-contents?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/tag-cloud?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/template-part?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/term-description?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/text-columns?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/verse?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/video?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/widget-area?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"core/widget-group?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiesandelementscomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesAndElementsComplete"))," } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"border?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"color?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"elements?"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"h1?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"h2?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"h3?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"h4?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"h5?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"h6?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"link?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#stylespropertiescomplete"},(0,n.kt)("inlineCode",{parentName:"a"},"StylesPropertiesComplete"))," } ; ",(0,n.kt)("inlineCode",{parentName:"p"},"spacing?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"typography?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")," }"),(0,n.kt)("p",null,"Organized way to set CSS properties. Styles in the top-level will be added in the ",(0,n.kt)("inlineCode",{parentName:"p"},"body")," selector."),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L210"},"packages/core/src/react/provider/types.ts:210")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"templateparts"},"templateParts"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"templateParts"),": { ",(0,n.kt)("inlineCode",{parentName:"p"},"area?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"title?"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," }[]"),(0,n.kt)("p",null,"Additional metadata for template parts defined in the parts folder."),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L336"},"packages/core/src/react/provider/types.ts:336")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"version"},"version"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"version"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"2")),(0,n.kt)("p",null,"Version of theme.json to use."),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/provider/types.ts#L103"},"packages/core/src/react/provider/types.ts:103")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a0d0f685.0f3abb02.js b/assets/js/a0d0f685.209df392.js similarity index 95% rename from assets/js/a0d0f685.0f3abb02.js rename to assets/js/a0d0f685.209df392.js index 2670a52f0..a425571c8 100644 --- a/assets/js/a0d0f685.0f3abb02.js +++ b/assets/js/a0d0f685.209df392.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2424],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var s=r.createContext({}),l=function(e){var t=r.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=l(e.components);return r.createElement(s.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,s=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),c=l(a),m=n,k=c["".concat(s,".").concat(m)]||c[m]||h[m]||i;return a?r.createElement(k,p(p({ref:t},o),{},{components:a})):r.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=m;var d={};for(var s in t)hasOwnProperty.call(t,s)&&(d[s]=t[s]);d.originalType=e,d[c]="string"==typeof e?e:n,p[1]=d;for(var l=2;l{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>d,toc:()=>l});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.VerifyTokenFetchStrategy",title:"Class: VerifyTokenFetchStrategy",sidebar_label:"@headstartwp/core.VerifyTokenFetchStrategy",custom_edit_url:null},p=void 0,d={unversionedId:"classes/headstartwp_core.VerifyTokenFetchStrategy",id:"classes/headstartwp_core.VerifyTokenFetchStrategy",title:"Class: VerifyTokenFetchStrategy",description:"@headstartwp/core.VerifyTokenFetchStrategy",source:"@site/docs/classes/headstartwp_core.VerifyTokenFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.VerifyTokenFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.VerifyTokenFetchStrategy",title:"Class: VerifyTokenFetchStrategy",sidebar_label:"@headstartwp/core.VerifyTokenFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.Text",permalink:"/docs/api/classes/headstartwp_core.Text"},next:{title:"@headstartwp/core.AppEntity",permalink:"/docs/api/interfaces/headstartwp_core.AppEntity"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getPreviewAuthHeader",id:"getpreviewauthheader",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getPreviewHeaderName",id:"getpreviewheadername",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-21",level:4}],o={toc:l};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".VerifyTokenFetchStrategy"),(0,n.kt)("p",null,"The Verify Token strategy is used to verify tokens issued by the\nheadless wp plugin"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),", ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),", ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"VerifyTokenFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new VerifyTokenFetchStrategy"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L143"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:143")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L119"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:119")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L124"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:124")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Builds the final endpoint URL based on the passed parameters"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams"},(0,n.kt)("inlineCode",{parentName:"a"},"VerifyTokenParams")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to add to the request")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The endpoint URL."),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts#L32"},"packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:32")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">",">"),(0,n.kt)("p",null,"The default fetcher function"),(0,n.kt)("p",null,"The default fetcher function handles authentication headers and errors from the API."),(0,n.kt)("p",null,"A custom strategy can override this function to run additional logic before or after the fetch call"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL to fetch")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams"},(0,n.kt)("inlineCode",{parentName:"a"},"VerifyTokenParams"))),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetcher options")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">",">"),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts#L39"},"packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:39")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"filterOptions?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"filterOptions?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L377"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:377")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">",">"),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L442"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:442")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L256"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:256")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L407"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:407")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides-2"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts#L23"},"packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:23")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L182"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:182")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L174"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:174")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("p",null,"Returns the supported params from the URL if present."),(0,n.kt)("p",null,"These params are passed to ",(0,n.kt)("inlineCode",{parentName:"p"},"buildEndpointURL"),". If the strategy does not support\nmapping url params to endpoint params, it should return an empty object."),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The Path name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("p",null,"params extracted from the URL"),(0,n.kt)("h4",{id:"overrides-3"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts#L28"},"packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:28")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewauthheader"},"getPreviewAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getpreviewauthheader"},"getPreviewAuthHeader")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L247"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:247")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewheadername"},"getPreviewHeaderName"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewHeaderName"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getpreviewheadername"},"getPreviewHeaderName")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L241"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:241")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L365"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:365")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L205"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:205")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),", ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),", ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L417"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:417")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L233"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:233")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-14"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-16"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L164"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:164")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-15"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-17"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2424],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var d=r.createContext({}),l=function(e){var t=r.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=l(e.components);return r.createElement(d.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,d=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),c=l(a),m=n,k=c["".concat(d,".").concat(m)]||c[m]||h[m]||i;return a?r.createElement(k,p(p({ref:t},o),{},{components:a})):r.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=m;var s={};for(var d in t)hasOwnProperty.call(t,d)&&(s[d]=t[d]);s.originalType=e,s[c]="string"==typeof e?e:n,p[1]=s;for(var l=2;l{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.VerifyTokenFetchStrategy",title:"Class: VerifyTokenFetchStrategy",sidebar_label:"@headstartwp/core.VerifyTokenFetchStrategy",custom_edit_url:null},p=void 0,s={unversionedId:"classes/headstartwp_core.VerifyTokenFetchStrategy",id:"classes/headstartwp_core.VerifyTokenFetchStrategy",title:"Class: VerifyTokenFetchStrategy",description:"@headstartwp/core.VerifyTokenFetchStrategy",source:"@site/docs/classes/headstartwp_core.VerifyTokenFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.VerifyTokenFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.VerifyTokenFetchStrategy",title:"Class: VerifyTokenFetchStrategy",sidebar_label:"@headstartwp/core.VerifyTokenFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.Text",permalink:"/docs/api/classes/headstartwp_core.Text"},next:{title:"@headstartwp/core.AppEntity",permalink:"/docs/api/interfaces/headstartwp_core.AppEntity"}},d={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getPreviewAuthHeader",id:"getpreviewauthheader",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getPreviewHeaderName",id:"getpreviewheadername",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-21",level:4}],o={toc:l};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".VerifyTokenFetchStrategy"),(0,n.kt)("p",null,"The Verify Token strategy is used to verify tokens issued by the\nheadless wp plugin"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),", ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),", ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"VerifyTokenFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new VerifyTokenFetchStrategy"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L143"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:143")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L119"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:119")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L124"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:124")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Builds the final endpoint URL based on the passed parameters"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams"},(0,n.kt)("inlineCode",{parentName:"a"},"VerifyTokenParams")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to add to the request")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The endpoint URL."),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts#L32"},"packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:32")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">",">"),(0,n.kt)("p",null,"The default fetcher function"),(0,n.kt)("p",null,"The default fetcher function handles authentication headers and errors from the API."),(0,n.kt)("p",null,"A custom strategy can override this function to run additional logic before or after the fetch call"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL to fetch")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams"},(0,n.kt)("inlineCode",{parentName:"a"},"VerifyTokenParams"))),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetcher options")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">",">"),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts#L39"},"packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:39")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"filterOptions?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"filterOptions?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L377"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:377")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">",">"),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L442"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:442")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L256"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:256")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L407"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:407")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides-2"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts#L23"},"packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:23")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L182"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:182")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L174"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:174")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("p",null,"Returns the supported params from the URL if present."),(0,n.kt)("p",null,"These params are passed to ",(0,n.kt)("inlineCode",{parentName:"p"},"buildEndpointURL"),". If the strategy does not support\nmapping url params to endpoint params, it should return an empty object."),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The Path name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("p",null,"params extracted from the URL"),(0,n.kt)("h4",{id:"overrides-3"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts#L28"},"packages/core/src/data/strategies/VerifyTokenFetchStrategy.ts:28")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewauthheader"},"getPreviewAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getpreviewauthheader"},"getPreviewAuthHeader")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L247"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:247")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewheadername"},"getPreviewHeaderName"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewHeaderName"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getpreviewheadername"},"getPreviewHeaderName")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L241"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:241")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L365"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:365")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L205"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:205")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),", ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),", ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">"),(0,n.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L417"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:417")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams")),">")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")),">"),(0,n.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L233"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:233")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-14"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-16"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L164"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:164")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-15"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-17"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a1514d7c.442233e1.js b/assets/js/a1514d7c.139462fd.js similarity index 97% rename from assets/js/a1514d7c.442233e1.js rename to assets/js/a1514d7c.139462fd.js index d95d540d8..3a4136a9e 100644 --- a/assets/js/a1514d7c.442233e1.js +++ b/assets/js/a1514d7c.139462fd.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2726],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),d=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},c=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),s=d(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},c),{},{components:a})):r.createElement(h,l({ref:t},c))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,l[1]=o;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.IMediaTextBlock",title:"Interface: IMediaTextBlock",sidebar_label:"@headstartwp/core.react.IMediaTextBlock",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.IMediaTextBlock",id:"interfaces/headstartwp_core.react.IMediaTextBlock",title:"Interface: IMediaTextBlock",description:"@headstartwp/core.react.IMediaTextBlock",source:"@site/docs/interfaces/headstartwp_core.react.IMediaTextBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IMediaTextBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IMediaTextBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IMediaTextBlock",title:"Interface: IMediaTextBlock",sidebar_label:"@headstartwp/core.react.IMediaTextBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IListBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IListBlock"},next:{title:"@headstartwp/core.react.IParagraphBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IParagraphBlock"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],c={toc:d};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IMediaTextBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"MediaTextBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IMediaTextBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"MediaTextBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"MediaTextBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2726],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),d=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},c=function(e){var t=d(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),s=d(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},c),{},{components:a})):r.createElement(h,l({ref:t},c))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,l[1]=o;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.IMediaTextBlock",title:"Interface: IMediaTextBlock",sidebar_label:"@headstartwp/core.react.IMediaTextBlock",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.IMediaTextBlock",id:"interfaces/headstartwp_core.react.IMediaTextBlock",title:"Interface: IMediaTextBlock",description:"@headstartwp/core.react.IMediaTextBlock",source:"@site/docs/interfaces/headstartwp_core.react.IMediaTextBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IMediaTextBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IMediaTextBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IMediaTextBlock",title:"Interface: IMediaTextBlock",sidebar_label:"@headstartwp/core.react.IMediaTextBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IListBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IListBlock"},next:{title:"@headstartwp/core.react.IParagraphBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IParagraphBlock"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],c={toc:d};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IMediaTextBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"MediaTextBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IMediaTextBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"MediaTextBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"MediaTextBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a222760f.7c4738d9.js b/assets/js/a222760f.9a07d885.js similarity index 99% rename from assets/js/a222760f.7c4738d9.js rename to assets/js/a222760f.9a07d885.js index a713a1142..e1d051436 100644 --- a/assets/js/a222760f.7c4738d9.js +++ b/assets/js/a222760f.9a07d885.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4637],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var d=n.createContext({}),p=function(e){var t=n.useContext(d),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=p(e.components);return n.createElement(d.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,d=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),c=p(r),u=a,m=c["".concat(d,".").concat(u)]||c[u]||k[u]||i;return r?n.createElement(m,l(l({ref:t},s),{},{components:r})):n.createElement(m,l({ref:t},s))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,l=new Array(i);l[0]=u;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o[c]="string"==typeof e?e:a,l[1]=o;for(var p=2;p{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const i={id:"headstartwp_core.NotFoundError",title:"Class: NotFoundError",sidebar_label:"@headstartwp/core.NotFoundError",custom_edit_url:null},l=void 0,o={unversionedId:"classes/headstartwp_core.NotFoundError",id:"classes/headstartwp_core.NotFoundError",title:"Class: NotFoundError",description:"@headstartwp/core.NotFoundError",source:"@site/docs/classes/headstartwp_core.NotFoundError.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.NotFoundError",permalink:"/docs/api/classes/headstartwp_core.NotFoundError",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.NotFoundError",title:"Class: NotFoundError",sidebar_label:"@headstartwp/core.NotFoundError",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.FrameworkError",permalink:"/docs/api/classes/headstartwp_core.FrameworkError"},next:{title:"@headstartwp/core.PostOrPostsFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"cause",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"stack",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"prepareStackTrace",id:"preparestacktrace",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],s={toc:p};function c(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".NotFoundError"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"Error")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"NotFoundError"))))),(0,a.kt)("h2",{id:"constructors"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new NotFoundError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"message"),")"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,"Error.constructor"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/errors.ts#L4"},"packages/core/src/utils/errors.ts:4")),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"cause"},"cause"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"cause"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"Error.cause"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"message"},"message"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"message"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"Error.message"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1054"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,"Error.name"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1053"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"stack"},"stack"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"stack"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,"Error.stack"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1055"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:127"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"preparestacktrace"},"prepareStackTrace"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"prepareStackTrace"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"err"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"stackTraces"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"CallSite"),"[]) => ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"err"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"stackTraces"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("p",null,"Optional override for formatting stack traces"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"See"))),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces"},"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces")),(0,a.kt)("h5",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"err")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Error"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"stackTraces")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"CallSite"),"[]")))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"Error.prepareStackTrace"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:140"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"stacktracelimit"},"stackTraceLimit"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"stackTraceLimit"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,"Error.stackTraceLimit"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:142"),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"capturestacktrace"},"captureStackTrace"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"captureStackTrace"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"targetObject"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"constructorOpt?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"Create .stack property on a target object"),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"targetObject")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Object"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"constructorOpt?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Function"))))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,"Error.captureStackTrace"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:133"))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4637],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var d=n.createContext({}),p=function(e){var t=n.useContext(d),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=p(e.components);return n.createElement(d.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,d=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),c=p(r),u=a,m=c["".concat(d,".").concat(u)]||c[u]||k[u]||i;return r?n.createElement(m,l(l({ref:t},s),{},{components:r})):n.createElement(m,l({ref:t},s))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,l=new Array(i);l[0]=u;var o={};for(var d in t)hasOwnProperty.call(t,d)&&(o[d]=t[d]);o.originalType=e,o[c]="string"==typeof e?e:a,l[1]=o;for(var p=2;p{r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const i={id:"headstartwp_core.NotFoundError",title:"Class: NotFoundError",sidebar_label:"@headstartwp/core.NotFoundError",custom_edit_url:null},l=void 0,o={unversionedId:"classes/headstartwp_core.NotFoundError",id:"classes/headstartwp_core.NotFoundError",title:"Class: NotFoundError",description:"@headstartwp/core.NotFoundError",source:"@site/docs/classes/headstartwp_core.NotFoundError.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.NotFoundError",permalink:"/docs/api/classes/headstartwp_core.NotFoundError",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.NotFoundError",title:"Class: NotFoundError",sidebar_label:"@headstartwp/core.NotFoundError",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.FrameworkError",permalink:"/docs/api/classes/headstartwp_core.FrameworkError"},next:{title:"@headstartwp/core.PostOrPostsFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy"}},d={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"cause",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"stack",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"prepareStackTrace",id:"preparestacktrace",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],s={toc:p};function c(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".NotFoundError"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("inlineCode",{parentName:"p"},"Error")),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"NotFoundError"))))),(0,a.kt)("h2",{id:"constructors"},"Constructors"),(0,a.kt)("h3",{id:"constructor"},"constructor"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"new NotFoundError"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"message"),")"),(0,a.kt)("h4",{id:"parameters"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"message")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"string"))))),(0,a.kt)("h4",{id:"overrides"},"Overrides"),(0,a.kt)("p",null,"Error.constructor"),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/errors.ts#L4"},"packages/core/src/utils/errors.ts:4")),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"cause"},"cause"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"cause"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"unknown")),(0,a.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,a.kt)("p",null,"Error.cause"),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"message"},"message"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"message"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,a.kt)("p",null,"Error.message"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1054"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"name"},"name"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"name"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,a.kt)("p",null,"Error.name"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1053"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"stack"},"stack"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"stack"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,a.kt)("p",null,"Error.stack"),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1055"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:127"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"preparestacktrace"},"prepareStackTrace"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"prepareStackTrace"),": (",(0,a.kt)("inlineCode",{parentName:"p"},"err"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"stackTraces"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"CallSite"),"[]) => ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (",(0,a.kt)("inlineCode",{parentName:"p"},"err"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"stackTraces"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("p",null,"Optional override for formatting stack traces"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"See"))),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces"},"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces")),(0,a.kt)("h5",{id:"parameters-1"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"err")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Error"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"stackTraces")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"CallSite"),"[]")))),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"any")),(0,a.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,a.kt)("p",null,"Error.prepareStackTrace"),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:140"),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"stacktracelimit"},"stackTraceLimit"),(0,a.kt)("p",null,"\u25aa ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"stackTraceLimit"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,a.kt)("p",null,"Error.stackTraceLimit"),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:142"),(0,a.kt)("h2",{id:"methods"},"Methods"),(0,a.kt)("h3",{id:"capturestacktrace"},"captureStackTrace"),(0,a.kt)("p",null,"\u25b8 ",(0,a.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,a.kt)("strong",{parentName:"p"},"captureStackTrace"),"(",(0,a.kt)("inlineCode",{parentName:"p"},"targetObject"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"constructorOpt?"),"): ",(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("p",null,"Create .stack property on a target object"),(0,a.kt)("h4",{id:"parameters-2"},"Parameters"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,a.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"targetObject")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Object"))),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"constructorOpt?")),(0,a.kt)("td",{parentName:"tr",align:"left"},(0,a.kt)("inlineCode",{parentName:"td"},"Function"))))),(0,a.kt)("h4",{id:"returns-1"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"void")),(0,a.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,a.kt)("p",null,"Error.captureStackTrace"),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,"node_modules/@types/node/globals.d.ts:133"))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a304918f.fdd0bea1.js b/assets/js/a304918f.9e17b1e7.js similarity index 87% rename from assets/js/a304918f.fdd0bea1.js rename to assets/js/a304918f.9e17b1e7.js index b39b98fee..ca1ef5e9e 100644 --- a/assets/js/a304918f.fdd0bea1.js +++ b/assets/js/a304918f.9e17b1e7.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1075],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var l=n.createContext({}),s=function(e){var t=n.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=s(e.components);return n.createElement(l.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,l=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),c=s(a),h=r,k=c["".concat(l,".").concat(h)]||c[h]||u[h]||i;return a?n.createElement(k,p(p({ref:t},o),{},{components:a})):n.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,p=new Array(i);p[0]=h;var d={};for(var l in t)hasOwnProperty.call(t,l)&&(d[l]=t[l]);d.originalType=e,d[c]="string"==typeof e?e:r,p[1]=d;for(var s=2;s{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>d,toc:()=>s});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.CommentEntity",title:"Interface: CommentEntity",sidebar_label:"@headstartwp/core.CommentEntity",custom_edit_url:null},p=void 0,d={unversionedId:"interfaces/headstartwp_core.CommentEntity",id:"interfaces/headstartwp_core.CommentEntity",title:"Interface: CommentEntity",description:"@headstartwp/core.CommentEntity",source:"@site/docs/interfaces/headstartwp_core.CommentEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.CommentEntity",permalink:"/docs/api/interfaces/headstartwp_core.CommentEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.CommentEntity",title:"Interface: CommentEntity",sidebar_label:"@headstartwp/core.CommentEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.AvatarUrls",permalink:"/docs/api/interfaces/headstartwp_core.AvatarUrls"},next:{title:"@headstartwp/core.EndpointParams",permalink:"/docs/api/interfaces/headstartwp_core.EndpointParams"}},l={},s=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"author",id:"author",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"author_avatar_urls",id:"author_avatar_urls",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"author_email",id:"author_email",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"author_name",id:"author_name",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"author_url",id:"author_url",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"content",id:"content",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"date",id:"date",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"date_gmt",id:"date_gmt",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"link",id:"link",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"meta",id:"meta",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"parent",id:"parent",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"post",id:"post",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-16",level:4}],o={toc:s};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".CommentEntity"),(0,r.kt)("p",null,"Interface for entities from the /wp/v2/comments endpoint."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,r.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"CommentEntity"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"author"},"author"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"author"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The ID of the user object, if author was a user."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L563"},"packages/core/src/data/types/entities.ts:563")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"author_avatar_urls"},"author","_","avatar","_","urls"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"author","_","avatar","_","urls"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AvatarUrls"},(0,r.kt)("inlineCode",{parentName:"a"},"AvatarUrls"))),(0,r.kt)("p",null,"Avatar URLs for the object author."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L623"},"packages/core/src/data/types/entities.ts:623")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"author_email"},"author","_","email"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"author","_","email"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Email address for the object author."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L568"},"packages/core/src/data/types/entities.ts:568")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"author_name"},"author","_","name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"author","_","name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Display name for the object author."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L573"},"packages/core/src/data/types/entities.ts:573")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"author_url"},"author","_","url"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"author","_","url"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"URL for the object author."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L578"},"packages/core/src/data/types/entities.ts:578")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"content"},"content"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"content"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,r.kt)("p",null,"The content for the object."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L583"},"packages/core/src/data/types/entities.ts:583")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"date"},"date"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"date"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The date the object was published, in the site's timezone."),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L588"},"packages/core/src/data/types/entities.ts:588")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"date_gmt"},"date","_","gmt"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"date","_","gmt"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The date the object was published, as GMT."),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L593"},"packages/core/src/data/types/entities.ts:593")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"id"},"id"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Unique identifier for the object."),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L558"},"packages/core/src/data/types/entities.ts:558")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"link"},"link"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"link"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"URL to the object."),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L598"},"packages/core/src/data/types/entities.ts:598")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"meta"},"meta"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,r.kt)("p",null,"Meta fields."),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L628"},"packages/core/src/data/types/entities.ts:628")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"parent"},"parent"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"parent"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The ID for the parent of the object."),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L603"},"packages/core/src/data/types/entities.ts:603")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"post"},"post"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"post"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The ID of the associated post object."),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L608"},"packages/core/src/data/types/entities.ts:608")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"status"},"status"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"status"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"State of the object."),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L613"},"packages/core/src/data/types/entities.ts:613")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"type"},"type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"type"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"comment"')),(0,r.kt)("p",null,"Type of Comment for the object."),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L618"},"packages/core/src/data/types/entities.ts:618")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1075],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var s=n.createContext({}),d=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=d(e.components);return n.createElement(s.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),c=d(a),h=r,k=c["".concat(s,".").concat(h)]||c[h]||u[h]||i;return a?n.createElement(k,p(p({ref:t},o),{},{components:a})):n.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,p=new Array(i);p[0]=h;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[c]="string"==typeof e?e:r,p[1]=l;for(var d=2;d{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>d});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.CommentEntity",title:"Interface: CommentEntity",sidebar_label:"@headstartwp/core.CommentEntity",custom_edit_url:null},p=void 0,l={unversionedId:"interfaces/headstartwp_core.CommentEntity",id:"interfaces/headstartwp_core.CommentEntity",title:"Interface: CommentEntity",description:"@headstartwp/core.CommentEntity",source:"@site/docs/interfaces/headstartwp_core.CommentEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.CommentEntity",permalink:"/docs/api/interfaces/headstartwp_core.CommentEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.CommentEntity",title:"Interface: CommentEntity",sidebar_label:"@headstartwp/core.CommentEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.AvatarUrls",permalink:"/docs/api/interfaces/headstartwp_core.AvatarUrls"},next:{title:"@headstartwp/core.EndpointParams",permalink:"/docs/api/interfaces/headstartwp_core.EndpointParams"}},s={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"author",id:"author",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"author_avatar_urls",id:"author_avatar_urls",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"author_email",id:"author_email",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"author_name",id:"author_name",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"author_url",id:"author_url",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"content",id:"content",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"date",id:"date",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"date_gmt",id:"date_gmt",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"link",id:"link",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"meta",id:"meta",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"parent",id:"parent",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"post",id:"post",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-16",level:4}],o={toc:d};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".CommentEntity"),(0,r.kt)("p",null,"Interface for entities from the /wp/v2/comments endpoint."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,r.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"CommentEntity"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"author"},"author"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"author"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The ID of the user object, if author was a user."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L563"},"packages/core/src/data/types/entities.ts:563")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"author_avatar_urls"},"author","_","avatar","_","urls"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"author","_","avatar","_","urls"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AvatarUrls"},(0,r.kt)("inlineCode",{parentName:"a"},"AvatarUrls"))),(0,r.kt)("p",null,"Avatar URLs for the object author."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L623"},"packages/core/src/data/types/entities.ts:623")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"author_email"},"author","_","email"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"author","_","email"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Email address for the object author."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L568"},"packages/core/src/data/types/entities.ts:568")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"author_name"},"author","_","name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"author","_","name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"Display name for the object author."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L573"},"packages/core/src/data/types/entities.ts:573")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"author_url"},"author","_","url"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"author","_","url"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"URL for the object author."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L578"},"packages/core/src/data/types/entities.ts:578")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"content"},"content"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"content"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Rendered"},(0,r.kt)("inlineCode",{parentName:"a"},"Rendered"))),(0,r.kt)("p",null,"The content for the object."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L583"},"packages/core/src/data/types/entities.ts:583")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"date"},"date"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"date"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The date the object was published, in the site's timezone."),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L588"},"packages/core/src/data/types/entities.ts:588")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"date_gmt"},"date","_","gmt"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"date","_","gmt"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The date the object was published, as GMT."),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L593"},"packages/core/src/data/types/entities.ts:593")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"id"},"id"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"id"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"Unique identifier for the object."),(0,r.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L558"},"packages/core/src/data/types/entities.ts:558")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"link"},"link"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"link"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"URL to the object."),(0,r.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L598"},"packages/core/src/data/types/entities.ts:598")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"meta"},"meta"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"meta"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown"),">"),(0,r.kt)("p",null,"Meta fields."),(0,r.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L628"},"packages/core/src/data/types/entities.ts:628")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"parent"},"parent"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"parent"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The ID for the parent of the object."),(0,r.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L603"},"packages/core/src/data/types/entities.ts:603")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"post"},"post"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"post"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"number")),(0,r.kt)("p",null,"The ID of the associated post object."),(0,r.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L608"},"packages/core/src/data/types/entities.ts:608")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"status"},"status"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"status"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"State of the object."),(0,r.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L613"},"packages/core/src/data/types/entities.ts:613")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"type"},"type"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"type"),": ",(0,r.kt)("inlineCode",{parentName:"p"},'"comment"')),(0,r.kt)("p",null,"Type of Comment for the object."),(0,r.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L618"},"packages/core/src/data/types/entities.ts:618")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,r.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,r.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a3f5e611.cd1d72c7.js b/assets/js/a3f5e611.47e56b63.js similarity index 94% rename from assets/js/a3f5e611.cd1d72c7.js rename to assets/js/a3f5e611.47e56b63.js index 0aa88b543..ec49a40b7 100644 --- a/assets/js/a3f5e611.cd1d72c7.js +++ b/assets/js/a3f5e611.47e56b63.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4222],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var c=a.createContext({}),p=function(e){var t=a.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=p(e.components);return a.createElement(c.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,c=e.parentName,s=i(e,["components","mdxType","originalType","parentName"]),d=p(r),u=n,h=d["".concat(c,".").concat(u)]||d[u]||k[u]||o;return r?a.createElement(h,l(l({ref:t},s),{},{components:r})):a.createElement(h,l({ref:t},s))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,l=new Array(o);l[0]=u;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i[d]="string"==typeof e?e:n,l[1]=i;for(var p=2;p{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.BlockAttributes",title:"Interface: BlockAttributes",sidebar_label:"@headstartwp/core.react.BlockAttributes",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.BlockAttributes",id:"interfaces/headstartwp_core.react.BlockAttributes",title:"Interface: BlockAttributes",description:"@headstartwp/core.react.BlockAttributes",source:"@site/docs/interfaces/headstartwp_core.react.BlockAttributes.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.BlockAttributes",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockAttributes",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.BlockAttributes",title:"Interface: BlockAttributes",sidebar_label:"@headstartwp/core.react.BlockAttributes",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.AudioBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps"},next:{title:"@headstartwp/core.react.BlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockProps"}},c={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"align",id:"align",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"backgroundColor",id:"backgroundcolor",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"backgroundColorSlug",id:"backgroundcolorslug",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"gradient",id:"gradient",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"gradientSlug",id:"gradientslug",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"linkColor",id:"linkcolor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"linkColorSlug",id:"linkcolorslug",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"textColor",id:"textcolor",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"textColorSlug",id:"textcolorslug",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"typography",id:"typography",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"width",id:"width",level:3},{value:"Defined in",id:"defined-in-11",level:4}],s={toc:p};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".BlockAttributes"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"BlockAttributes"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"align"},"align"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"align"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align"))),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L95"},"packages/core/src/react/blocks/types.ts:95")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"backgroundcolor"},"backgroundColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"backgroundColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#backgroundcolor"},"backgroundColor")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L6"},"packages/core/src/react/blocks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"backgroundcolorslug"},"backgroundColorSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"backgroundColorSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#backgroundcolorslug"},"backgroundColorSlug")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L5"},"packages/core/src/react/blocks/types.ts:5")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"gradient"},"gradient"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"gradient"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#gradient"},"gradient")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L8"},"packages/core/src/react/blocks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"gradientslug"},"gradientSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"gradientSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#gradientslug"},"gradientSlug")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L7"},"packages/core/src/react/blocks/types.ts:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"linkcolor"},"linkColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"linkColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#linkcolor"},"linkColor")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L12"},"packages/core/src/react/blocks/types.ts:12")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"linkcolorslug"},"linkColorSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"linkColorSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#linkcolorslug"},"linkColorSlug")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L11"},"packages/core/src/react/blocks/types.ts:11")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#style"},(0,n.kt)("inlineCode",{parentName:"a"},"Style")),">"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L96"},"packages/core/src/react/blocks/types.ts:96")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"textcolor"},"textColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"textColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#textcolor"},"textColor")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L10"},"packages/core/src/react/blocks/types.ts:10")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"textcolorslug"},"textColorSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"textColorSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#textcolorslug"},"textColorSlug")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L9"},"packages/core/src/react/blocks/types.ts:9")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"typography"},"typography"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"typography"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography"))),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L98"},"packages/core/src/react/blocks/types.ts:98")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"width"},"width"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"width"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L97"},"packages/core/src/react/blocks/types.ts:97")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4222],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var c=a.createContext({}),p=function(e){var t=a.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=p(e.components);return a.createElement(c.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,c=e.parentName,s=i(e,["components","mdxType","originalType","parentName"]),d=p(r),u=n,h=d["".concat(c,".").concat(u)]||d[u]||k[u]||o;return r?a.createElement(h,l(l({ref:t},s),{},{components:r})):a.createElement(h,l({ref:t},s))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,l=new Array(o);l[0]=u;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i[d]="string"==typeof e?e:n,l[1]=i;for(var p=2;p{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.BlockAttributes",title:"Interface: BlockAttributes",sidebar_label:"@headstartwp/core.react.BlockAttributes",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.BlockAttributes",id:"interfaces/headstartwp_core.react.BlockAttributes",title:"Interface: BlockAttributes",description:"@headstartwp/core.react.BlockAttributes",source:"@site/docs/interfaces/headstartwp_core.react.BlockAttributes.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.BlockAttributes",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockAttributes",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.BlockAttributes",title:"Interface: BlockAttributes",sidebar_label:"@headstartwp/core.react.BlockAttributes",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.AudioBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps"},next:{title:"@headstartwp/core.react.BlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.BlockProps"}},c={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"align",id:"align",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"backgroundColor",id:"backgroundcolor",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"backgroundColorSlug",id:"backgroundcolorslug",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"gradient",id:"gradient",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"gradientSlug",id:"gradientslug",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"linkColor",id:"linkcolor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"linkColorSlug",id:"linkcolorslug",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"textColor",id:"textcolor",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"textColorSlug",id:"textcolorslug",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"typography",id:"typography",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"width",id:"width",level:3},{value:"Defined in",id:"defined-in-11",level:4}],s={toc:p};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".BlockAttributes"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"BlockAttributes"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"align"},"align"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"align"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align"))),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L95"},"packages/core/src/react/blocks/types.ts:95")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"backgroundcolor"},"backgroundColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"backgroundColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#backgroundcolor"},"backgroundColor")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L6"},"packages/core/src/react/blocks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"backgroundcolorslug"},"backgroundColorSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"backgroundColorSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#backgroundcolorslug"},"backgroundColorSlug")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L5"},"packages/core/src/react/blocks/types.ts:5")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"gradient"},"gradient"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"gradient"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#gradient"},"gradient")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L8"},"packages/core/src/react/blocks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"gradientslug"},"gradientSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"gradientSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#gradientslug"},"gradientSlug")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L7"},"packages/core/src/react/blocks/types.ts:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"linkcolor"},"linkColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"linkColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#linkcolor"},"linkColor")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L12"},"packages/core/src/react/blocks/types.ts:12")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"linkcolorslug"},"linkColorSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"linkColorSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#linkcolorslug"},"linkColorSlug")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L11"},"packages/core/src/react/blocks/types.ts:11")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#style"},(0,n.kt)("inlineCode",{parentName:"a"},"Style")),">"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L96"},"packages/core/src/react/blocks/types.ts:96")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"textcolor"},"textColor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"textColor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#textcolor"},"textColor")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L10"},"packages/core/src/react/blocks/types.ts:10")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"textcolorslug"},"textColorSlug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"textColorSlug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},"Colors"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Colors#textcolorslug"},"textColorSlug")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L9"},"packages/core/src/react/blocks/types.ts:9")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"typography"},"typography"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"typography"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography"))),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L98"},"packages/core/src/react/blocks/types.ts:98")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"width"},"width"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"width"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L97"},"packages/core/src/react/blocks/types.ts:97")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a40ccb42.d5b8d674.js b/assets/js/a40ccb42.7729dd92.js similarity index 97% rename from assets/js/a40ccb42.d5b8d674.js rename to assets/js/a40ccb42.7729dd92.js index 3a292ddc7..0c282f29e 100644 --- a/assets/js/a40ccb42.d5b8d674.js +++ b/assets/js/a40ccb42.7729dd92.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8081],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),k=n,h=s["".concat(p,".").concat(k)]||s[k]||m[k]||l;return a?r.createElement(h,i(i({ref:t},d),{},{components:a})):r.createElement(h,i({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,i=new Array(l);i[0]=k;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.IImageBlock",title:"Interface: IImageBlock",sidebar_label:"@headstartwp/core.react.IImageBlock",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.IImageBlock",id:"interfaces/headstartwp_core.react.IImageBlock",title:"Interface: IImageBlock",description:"@headstartwp/core.react.IImageBlock",source:"@site/docs/interfaces/headstartwp_core.react.IImageBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IImageBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IImageBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IImageBlock",title:"Interface: IImageBlock",sidebar_label:"@headstartwp/core.react.IImageBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IHeadingBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IHeadingBlock"},next:{title:"@headstartwp/core.react.IListBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IListBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IImageBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ImageBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IImageBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ImageBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ImageBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8081],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),k=n,h=s["".concat(p,".").concat(k)]||s[k]||m[k]||l;return a?r.createElement(h,i(i({ref:t},d),{},{components:a})):r.createElement(h,i({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,i=new Array(l);i[0]=k;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.IImageBlock",title:"Interface: IImageBlock",sidebar_label:"@headstartwp/core.react.IImageBlock",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.IImageBlock",id:"interfaces/headstartwp_core.react.IImageBlock",title:"Interface: IImageBlock",description:"@headstartwp/core.react.IImageBlock",source:"@site/docs/interfaces/headstartwp_core.react.IImageBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IImageBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IImageBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IImageBlock",title:"Interface: IImageBlock",sidebar_label:"@headstartwp/core.react.IImageBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IHeadingBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IHeadingBlock"},next:{title:"@headstartwp/core.react.IListBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IListBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IImageBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ImageBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IImageBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ImageBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"ImageBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a4f5c2b9.c230b76d.js b/assets/js/a4f5c2b9.c230b76d.js deleted file mode 100644 index 92d8e1b12..000000000 --- a/assets/js/a4f5c2b9.c230b76d.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[607],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>h});var i=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);t&&(i=i.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,i)}return n}function p(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=i.createContext({}),s=function(e){var t=i.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},c=function(e){var t=s(e.components);return i.createElement(l.Provider,{value:t},e.children)},o="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return i.createElement(i.Fragment,{},t)}},k=i.forwardRef((function(e,t){var n=e.components,a=e.mdxType,r=e.originalType,l=e.parentName,c=d(e,["components","mdxType","originalType","parentName"]),o=s(n),k=a,h=o["".concat(l,".").concat(k)]||o[k]||u[k]||r;return n?i.createElement(h,p(p({ref:t},c),{},{components:n})):i.createElement(h,p({ref:t},c))}));function h(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var r=n.length,p=new Array(r);p[0]=k;var d={};for(var l in t)hasOwnProperty.call(t,l)&&(d[l]=t[l]);d.originalType=e,d[o]="string"==typeof e?e:a,p[1]=d;for(var s=2;s{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>o,frontMatter:()=>r,metadata:()=>d,toc:()=>s});var i=n(7462),a=(n(7294),n(3905));const r={id:"headstartwp_core.MenuItemEntity",title:"Interface: MenuItemEntity",sidebar_label:"@headstartwp/core.MenuItemEntity",custom_edit_url:null},p=void 0,d={unversionedId:"interfaces/headstartwp_core.MenuItemEntity",id:"interfaces/headstartwp_core.MenuItemEntity",title:"Interface: MenuItemEntity",description:"@headstartwp/core.MenuItemEntity",source:"@site/docs/interfaces/headstartwp_core.MenuItemEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.MenuItemEntity",permalink:"/docs/api/interfaces/headstartwp_core.MenuItemEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.MenuItemEntity",title:"Interface: MenuItemEntity",sidebar_label:"@headstartwp/core.MenuItemEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.Integration",permalink:"/docs/api/interfaces/headstartwp_core.Integration"},next:{title:"@headstartwp/core.PageEntity",permalink:"/docs/api/interfaces/headstartwp_core.PageEntity"}},l={},s=[{value:"Properties",id:"properties",level:2},{value:"ID",id:"id",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"attr_title",id:"attr_title",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"children",id:"children",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"classes",id:"classes",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"menu_item_parent",id:"menu_item_parent",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"menu_order",id:"menu_order",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"object",id:"object",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"object_id",id:"object_id",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"order",id:"order",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"post_mime_type",id:"post_mime_type",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"post_type",id:"post_type",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"target",id:"target",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"type_label",id:"type_label",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-17",level:4}],c={toc:s};function o(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,i.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".MenuItemEntity"),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"id"},"ID"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"ID"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L715"},"packages/core/src/data/types/entities.ts:715")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"attr_title"},"attr","_","title"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"attr","_","title"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L727"},"packages/core/src/data/types/entities.ts:727")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"children"},"children"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"children"),": ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"},(0,a.kt)("inlineCode",{parentName:"a"},"MenuItemEntity")),"[]"),(0,a.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L731"},"packages/core/src/data/types/entities.ts:731")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"classes"},"classes"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"classes"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,a.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L729"},"packages/core/src/data/types/entities.ts:729")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"description"},"description"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"description"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L728"},"packages/core/src/data/types/entities.ts:728")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"menu_item_parent"},"menu","_","item","_","parent"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"menu","_","item","_","parent"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L719"},"packages/core/src/data/types/entities.ts:719")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"menu_order"},"menu","_","order"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"menu","_","order"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L716"},"packages/core/src/data/types/entities.ts:716")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"object"},"object"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"object"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L721"},"packages/core/src/data/types/entities.ts:721")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"object_id"},"object","_","id"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"object","_","id"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L720"},"packages/core/src/data/types/entities.ts:720")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"order"},"order"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"order"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"number")),(0,a.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L732"},"packages/core/src/data/types/entities.ts:732")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"post_mime_type"},"post","_","mime","_","type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"post","_","mime","_","type"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L718"},"packages/core/src/data/types/entities.ts:718")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"post_type"},"post","_","type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"post","_","type"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L717"},"packages/core/src/data/types/entities.ts:717")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"slug"},"slug"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"slug"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L730"},"packages/core/src/data/types/entities.ts:730")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"target"},"target"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"target"),": ",(0,a.kt)("inlineCode",{parentName:"p"},'"_blank"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"_self"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"_parent"')," ","|"," ",(0,a.kt)("inlineCode",{parentName:"p"},'"_top"')),(0,a.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L726"},"packages/core/src/data/types/entities.ts:726")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"title"},"title"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"title"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L725"},"packages/core/src/data/types/entities.ts:725")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type"},"type"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"type"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L722"},"packages/core/src/data/types/entities.ts:722")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"type_label"},"type","_","label"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"type","_","label"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L723"},"packages/core/src/data/types/entities.ts:723")),(0,a.kt)("hr",null),(0,a.kt)("h3",{id:"url"},"url"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"url"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"string")),(0,a.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L724"},"packages/core/src/data/types/entities.ts:724")))}o.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a4f5c2b9.c79848f5.js b/assets/js/a4f5c2b9.c79848f5.js new file mode 100644 index 000000000..baaeba5d1 --- /dev/null +++ b/assets/js/a4f5c2b9.c79848f5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[607],{3905:(e,t,n)=>{n.d(t,{Zo:()=>o,kt:()=>h});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function p(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=a.createContext({}),d=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},o=function(e){var t=d(e.components);return a.createElement(s.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},k=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),c=d(n),k=i,h=c["".concat(s,".").concat(k)]||c[k]||u[k]||r;return n?a.createElement(h,p(p({ref:t},o),{},{components:n})):a.createElement(h,p({ref:t},o))}));function h(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,p=new Array(r);p[0]=k;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[c]="string"==typeof e?e:i,p[1]=l;for(var d=2;d{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>c,frontMatter:()=>r,metadata:()=>l,toc:()=>d});var a=n(7462),i=(n(7294),n(3905));const r={id:"headstartwp_core.MenuItemEntity",title:"Interface: MenuItemEntity",sidebar_label:"@headstartwp/core.MenuItemEntity",custom_edit_url:null},p=void 0,l={unversionedId:"interfaces/headstartwp_core.MenuItemEntity",id:"interfaces/headstartwp_core.MenuItemEntity",title:"Interface: MenuItemEntity",description:"@headstartwp/core.MenuItemEntity",source:"@site/docs/interfaces/headstartwp_core.MenuItemEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.MenuItemEntity",permalink:"/docs/api/interfaces/headstartwp_core.MenuItemEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.MenuItemEntity",title:"Interface: MenuItemEntity",sidebar_label:"@headstartwp/core.MenuItemEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.Integration",permalink:"/docs/api/interfaces/headstartwp_core.Integration"},next:{title:"@headstartwp/core.PageEntity",permalink:"/docs/api/interfaces/headstartwp_core.PageEntity"}},s={},d=[{value:"Properties",id:"properties",level:2},{value:"ID",id:"id",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"attr_title",id:"attr_title",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"children",id:"children",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"classes",id:"classes",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"menu_item_parent",id:"menu_item_parent",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"menu_order",id:"menu_order",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"object",id:"object",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"object_id",id:"object_id",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"order",id:"order",level:3},{value:"Defined in",id:"defined-in-9",level:4},{value:"post_mime_type",id:"post_mime_type",level:3},{value:"Defined in",id:"defined-in-10",level:4},{value:"post_type",id:"post_type",level:3},{value:"Defined in",id:"defined-in-11",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-12",level:4},{value:"target",id:"target",level:3},{value:"Defined in",id:"defined-in-13",level:4},{value:"title",id:"title",level:3},{value:"Defined in",id:"defined-in-14",level:4},{value:"type",id:"type",level:3},{value:"Defined in",id:"defined-in-15",level:4},{value:"type_label",id:"type_label",level:3},{value:"Defined in",id:"defined-in-16",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-17",level:4}],o={toc:d};function c(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,a.Z)({},o,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".MenuItemEntity"),(0,i.kt)("h2",{id:"properties"},"Properties"),(0,i.kt)("h3",{id:"id"},"ID"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"ID"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"defined-in"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L715"},"packages/core/src/data/types/entities.ts:715")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"attr_title"},"attr","_","title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"attr","_","title"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L727"},"packages/core/src/data/types/entities.ts:727")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"children"},"children"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"children"),": ",(0,i.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"},(0,i.kt)("inlineCode",{parentName:"a"},"MenuItemEntity")),"[]"),(0,i.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L731"},"packages/core/src/data/types/entities.ts:731")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"classes"},"classes"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"classes"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,i.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L729"},"packages/core/src/data/types/entities.ts:729")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"description"},"description"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"description"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L728"},"packages/core/src/data/types/entities.ts:728")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"menu_item_parent"},"menu","_","item","_","parent"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"menu","_","item","_","parent"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L719"},"packages/core/src/data/types/entities.ts:719")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"menu_order"},"menu","_","order"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"menu","_","order"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L716"},"packages/core/src/data/types/entities.ts:716")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"object"},"object"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"object"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L721"},"packages/core/src/data/types/entities.ts:721")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"object_id"},"object","_","id"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"object","_","id"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L720"},"packages/core/src/data/types/entities.ts:720")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"order"},"order"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"order"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"number")),(0,i.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L732"},"packages/core/src/data/types/entities.ts:732")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"post_mime_type"},"post","_","mime","_","type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"post","_","mime","_","type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L718"},"packages/core/src/data/types/entities.ts:718")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"post_type"},"post","_","type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"post","_","type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L717"},"packages/core/src/data/types/entities.ts:717")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"slug"},"slug"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"slug"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L730"},"packages/core/src/data/types/entities.ts:730")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"target"},"target"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"target"),": ",(0,i.kt)("inlineCode",{parentName:"p"},'"_blank"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"_self"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"_parent"')," ","|"," ",(0,i.kt)("inlineCode",{parentName:"p"},'"_top"')),(0,i.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L726"},"packages/core/src/data/types/entities.ts:726")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"title"},"title"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"title"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L725"},"packages/core/src/data/types/entities.ts:725")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"type"},"type"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"type"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L722"},"packages/core/src/data/types/entities.ts:722")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"type_label"},"type","_","label"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"type","_","label"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L723"},"packages/core/src/data/types/entities.ts:723")),(0,i.kt)("hr",null),(0,i.kt)("h3",{id:"url"},"url"),(0,i.kt)("p",null,"\u2022 ",(0,i.kt)("strong",{parentName:"p"},"url"),": ",(0,i.kt)("inlineCode",{parentName:"p"},"string")),(0,i.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,i.kt)("p",null,(0,i.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L724"},"packages/core/src/data/types/entities.ts:724")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a56bba46.c300343a.js b/assets/js/a56bba46.f12696b3.js similarity index 97% rename from assets/js/a56bba46.c300343a.js rename to assets/js/a56bba46.f12696b3.js index 61f8a37de..34cefb610 100644 --- a/assets/js/a56bba46.c300343a.js +++ b/assets/js/a56bba46.f12696b3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7148],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>u});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var l=n.createContext({}),s=function(e){var t=n.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=s(e.components);return n.createElement(l.Provider,{value:t},e.children)},c="mdxType",f={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,o=e.originalType,l=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),c=s(a),h=r,u=c["".concat(l,".").concat(h)]||c[h]||f[h]||o;return a?n.createElement(u,i(i({ref:t},d),{},{components:a})):n.createElement(u,i({ref:t},d))}));function u(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=a.length,i=new Array(o);i[0]=h;var p={};for(var l in t)hasOwnProperty.call(t,l)&&(p[l]=t[l]);p.originalType=e,p[c]="string"==typeof e?e:r,i[1]=p;for(var s=2;s{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>c,frontMatter:()=>o,metadata:()=>p,toc:()=>s});var n=a(7462),r=(a(7294),a(3905));const o={id:"headstartwp_next.FetchHookDataOptions",title:"Interface: FetchHookDataOptions",sidebar_label:"@headstartwp/next.FetchHookDataOptions",custom_edit_url:null},i=void 0,p={unversionedId:"interfaces/headstartwp_next.FetchHookDataOptions",id:"interfaces/headstartwp_next.FetchHookDataOptions",title:"Interface: FetchHookDataOptions",description:"@headstartwp/next.FetchHookDataOptions",source:"@site/docs/interfaces/headstartwp_next.FetchHookDataOptions.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_next.FetchHookDataOptions",permalink:"/docs/api/interfaces/headstartwp_next.FetchHookDataOptions",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_next.FetchHookDataOptions",title:"Interface: FetchHookDataOptions",sidebar_label:"@headstartwp/next.FetchHookDataOptions",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.useTermsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse"},next:{title:"@headstartwp/next.ImageProps",permalink:"/docs/api/interfaces/headstartwp_next.ImageProps"}},l={},s=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"fetchStrategyOptions",id:"fetchstrategyoptions",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"params",id:"params",level:3},{value:"Defined in",id:"defined-in-2",level:4}],d={toc:s};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next"},"@headstartwp/next"),".FetchHookDataOptions"),(0,r.kt)("p",null,"The supported options for ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#fetchhookdata"},"fetchHookData")),(0,r.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"unknown"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"unknown"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"fetchstrategyoptions"},"fetchStrategyOptions"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"fetchStrategyOptions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"FetchOptions"),">"),(0,r.kt)("p",null,"Optional. If set, will forward fetch options to the fetch strategy"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/server/fetchHookData.ts#L34"},"packages/next/src/data/server/fetchHookData.ts:34")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"filterdata"},"filterData"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"filterData"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"FilterDataOptions"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"Optional. If set, the data will be filtered given FilterDataOptions"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/server/fetchHookData.ts#L29"},"packages/next/src/data/server/fetchHookData.ts:29")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"params"},"params"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"params"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"P")),(0,r.kt)("p",null,"This should match params passed to the hook on the client side."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/data/server/fetchHookData.ts#L24"},"packages/next/src/data/server/fetchHookData.ts:24")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7148],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>u});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var l=n.createContext({}),s=function(e){var t=n.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=s(e.components);return n.createElement(l.Provider,{value:t},e.children)},c="mdxType",f={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,o=e.originalType,l=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),c=s(a),h=r,u=c["".concat(l,".").concat(h)]||c[h]||f[h]||o;return a?n.createElement(u,i(i({ref:t},d),{},{components:a})):n.createElement(u,i({ref:t},d))}));function u(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=a.length,i=new Array(o);i[0]=h;var p={};for(var l in t)hasOwnProperty.call(t,l)&&(p[l]=t[l]);p.originalType=e,p[c]="string"==typeof e?e:r,i[1]=p;for(var s=2;s{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>c,frontMatter:()=>o,metadata:()=>p,toc:()=>s});var n=a(7462),r=(a(7294),a(3905));const o={id:"headstartwp_next.FetchHookDataOptions",title:"Interface: FetchHookDataOptions",sidebar_label:"@headstartwp/next.FetchHookDataOptions",custom_edit_url:null},i=void 0,p={unversionedId:"interfaces/headstartwp_next.FetchHookDataOptions",id:"interfaces/headstartwp_next.FetchHookDataOptions",title:"Interface: FetchHookDataOptions",description:"@headstartwp/next.FetchHookDataOptions",source:"@site/docs/interfaces/headstartwp_next.FetchHookDataOptions.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_next.FetchHookDataOptions",permalink:"/docs/api/interfaces/headstartwp_next.FetchHookDataOptions",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_next.FetchHookDataOptions",title:"Interface: FetchHookDataOptions",sidebar_label:"@headstartwp/next.FetchHookDataOptions",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.useTermsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse"},next:{title:"@headstartwp/next.ImageProps",permalink:"/docs/api/interfaces/headstartwp_next.ImageProps"}},l={},s=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"fetchStrategyOptions",id:"fetchstrategyoptions",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"params",id:"params",level:3},{value:"Defined in",id:"defined-in-2",level:4}],d={toc:s};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next"},"@headstartwp/next"),".FetchHookDataOptions"),(0,r.kt)("p",null,"The supported options for ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next#fetchhookdata"},"fetchHookData")),(0,r.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"P")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"unknown"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"T")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"unknown"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"fetchstrategyoptions"},"fetchStrategyOptions"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"fetchStrategyOptions"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"FetchOptions"),">"),(0,r.kt)("p",null,"Optional. If set, will forward fetch options to the fetch strategy"),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/server/fetchHookData.ts#L34"},"packages/next/src/data/server/fetchHookData.ts:34")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"filterdata"},"filterData"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"filterData"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"FilterDataOptions"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"T"),">"),(0,r.kt)("p",null,"Optional. If set, the data will be filtered given FilterDataOptions"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/server/fetchHookData.ts#L29"},"packages/next/src/data/server/fetchHookData.ts:29")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"params"},"params"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"params"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"P")),(0,r.kt)("p",null,"This should match params passed to the hook on the client side."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/data/server/fetchHookData.ts#L24"},"packages/next/src/data/server/fetchHookData.ts:24")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/a56c2626.9d7c247e.js b/assets/js/a56c2626.0a5e3ee5.js similarity index 98% rename from assets/js/a56c2626.9d7c247e.js rename to assets/js/a56c2626.0a5e3ee5.js index d1abcaaeb..4b1e0a6f1 100644 --- a/assets/js/a56c2626.9d7c247e.js +++ b/assets/js/a56c2626.0a5e3ee5.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2973],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>f});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function c(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var i=n.createContext({}),p=function(e){var t=n.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):c(c({},t),e)),r},l=function(e){var t=p(e.components);return n.createElement(i.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,i=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),u=p(r),h=a,f=u["".concat(i,".").concat(h)]||u[h]||d[h]||o;return r?n.createElement(f,c(c({ref:t},l),{},{components:r})):n.createElement(f,c({ref:t},l))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,c=new Array(o);c[0]=h;var s={};for(var i in t)hasOwnProperty.call(t,i)&&(s[i]=t[i]);s.originalType=e,s[u]="string"==typeof e?e:a,c[1]=s;for(var p=2;p{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const o={id:"headstartwp_core.react.useFetchOptions",title:"Interface: useFetchOptions",sidebar_label:"@headstartwp/core.react.useFetchOptions",custom_edit_url:null},c=void 0,s={unversionedId:"interfaces/headstartwp_core.react.useFetchOptions",id:"interfaces/headstartwp_core.react.useFetchOptions",title:"Interface: useFetchOptions",description:"@headstartwp/core.react.useFetchOptions",source:"@site/docs/interfaces/headstartwp_core.react.useFetchOptions.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.useFetchOptions",permalink:"/docs/api/interfaces/headstartwp_core.react.useFetchOptions",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.useFetchOptions",title:"Interface: useFetchOptions",sidebar_label:"@headstartwp/core.react.useFetchOptions",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.useAppSettingsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse"},next:{title:"@headstartwp/core.react.useMenuResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse"}},i={},p=[{value:"Properties",id:"properties",level:2},{value:"shouldFetch",id:"shouldfetch",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in",level:4}],l={toc:p};function u(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".useFetchOptions"),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"shouldfetch"},"shouldFetch"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"shouldFetch"),": () => ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/useFetch.ts#L11"},"packages/core/src/react/hooks/useFetch.ts:11")))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2973],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>f});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function c(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var i=n.createContext({}),p=function(e){var t=n.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):c(c({},t),e)),r},l=function(e){var t=p(e.components);return n.createElement(i.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,i=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),u=p(r),h=a,f=u["".concat(i,".").concat(h)]||u[h]||d[h]||o;return r?n.createElement(f,c(c({ref:t},l),{},{components:r})):n.createElement(f,c({ref:t},l))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,c=new Array(o);c[0]=h;var s={};for(var i in t)hasOwnProperty.call(t,i)&&(s[i]=t[i]);s.originalType=e,s[u]="string"==typeof e?e:a,c[1]=s;for(var p=2;p{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>c,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const o={id:"headstartwp_core.react.useFetchOptions",title:"Interface: useFetchOptions",sidebar_label:"@headstartwp/core.react.useFetchOptions",custom_edit_url:null},c=void 0,s={unversionedId:"interfaces/headstartwp_core.react.useFetchOptions",id:"interfaces/headstartwp_core.react.useFetchOptions",title:"Interface: useFetchOptions",description:"@headstartwp/core.react.useFetchOptions",source:"@site/docs/interfaces/headstartwp_core.react.useFetchOptions.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.useFetchOptions",permalink:"/docs/api/interfaces/headstartwp_core.react.useFetchOptions",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.useFetchOptions",title:"Interface: useFetchOptions",sidebar_label:"@headstartwp/core.react.useFetchOptions",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.useAppSettingsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse"},next:{title:"@headstartwp/core.react.useMenuResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse"}},i={},p=[{value:"Properties",id:"properties",level:2},{value:"shouldFetch",id:"shouldfetch",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in",level:4}],l={toc:p};function u(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,a.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".useFetchOptions"),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"shouldfetch"},"shouldFetch"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,a.kt)("strong",{parentName:"p"},"shouldFetch"),": () => ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,a.kt)("p",null,"\u25b8 (): ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h5",{id:"returns"},"Returns"),(0,a.kt)("p",null,(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetch.ts#L11"},"packages/core/src/react/hooks/useFetch.ts:11")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ac461116.782747a4.js b/assets/js/ac461116.51d1a14f.js similarity index 96% rename from assets/js/ac461116.782747a4.js rename to assets/js/ac461116.51d1a14f.js index 1bfc9fef6..d6783d1b7 100644 --- a/assets/js/ac461116.782747a4.js +++ b/assets/js/ac461116.51d1a14f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3514],{3905:(e,t,r)=>{r.d(t,{Zo:()=>i,kt:()=>k});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function c(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var c=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var s=a.createContext({}),l=function(e){var t=a.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},i=function(e){var t=l(e.components);return a.createElement(s.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},f=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,c=e.originalType,s=e.parentName,i=p(e,["components","mdxType","originalType","parentName"]),d=l(r),f=n,k=d["".concat(s,".").concat(f)]||d[f]||u[f]||c;return r?a.createElement(k,o(o({ref:t},i),{},{components:r})):a.createElement(k,o({ref:t},i))}));function k(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var c=r.length,o=new Array(c);o[0]=f;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[d]="string"==typeof e?e:n,o[1]=p;for(var l=2;l{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>d,frontMatter:()=>c,metadata:()=>p,toc:()=>l});var a=r(7462),n=(r(7294),r(3905));const c={id:"headstartwp_core.react.GutenbergBlockProps",title:"Interface: GutenbergBlockProps",sidebar_label:"@headstartwp/core.react.GutenbergBlockProps",custom_edit_url:null},o=void 0,p={unversionedId:"interfaces/headstartwp_core.react.GutenbergBlockProps",id:"interfaces/headstartwp_core.react.GutenbergBlockProps",title:"Interface: GutenbergBlockProps",description:"@headstartwp/core.react.GutenbergBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.GutenbergBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.GutenbergBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.GutenbergBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.GutenbergBlockProps",title:"Interface: GutenbergBlockProps",sidebar_label:"@headstartwp/core.react.GutenbergBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.GroupBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps"},next:{title:"@headstartwp/core.react.HeadingBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps"}},s={},l=[{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"className",id:"classname",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-2",level:4}],i={toc:l};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},i,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".GutenbergBlockProps"),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L62"},"packages/core/src/react/blocks/types.ts:62")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L61"},"packages/core/src/react/blocks/types.ts:61")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L60"},"packages/core/src/react/blocks/types.ts:60")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3514],{3905:(e,t,r)=>{r.d(t,{Zo:()=>i,kt:()=>k});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function c(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var c=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var s=a.createContext({}),l=function(e){var t=a.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},i=function(e){var t=l(e.components);return a.createElement(s.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},f=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,c=e.originalType,s=e.parentName,i=p(e,["components","mdxType","originalType","parentName"]),d=l(r),f=n,k=d["".concat(s,".").concat(f)]||d[f]||u[f]||c;return r?a.createElement(k,o(o({ref:t},i),{},{components:r})):a.createElement(k,o({ref:t},i))}));function k(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var c=r.length,o=new Array(c);o[0]=f;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[d]="string"==typeof e?e:n,o[1]=p;for(var l=2;l{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>d,frontMatter:()=>c,metadata:()=>p,toc:()=>l});var a=r(7462),n=(r(7294),r(3905));const c={id:"headstartwp_core.react.GutenbergBlockProps",title:"Interface: GutenbergBlockProps",sidebar_label:"@headstartwp/core.react.GutenbergBlockProps",custom_edit_url:null},o=void 0,p={unversionedId:"interfaces/headstartwp_core.react.GutenbergBlockProps",id:"interfaces/headstartwp_core.react.GutenbergBlockProps",title:"Interface: GutenbergBlockProps",description:"@headstartwp/core.react.GutenbergBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.GutenbergBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.GutenbergBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.GutenbergBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.GutenbergBlockProps",title:"Interface: GutenbergBlockProps",sidebar_label:"@headstartwp/core.react.GutenbergBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.GroupBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps"},next:{title:"@headstartwp/core.react.HeadingBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps"}},s={},l=[{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"className",id:"classname",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-2",level:4}],i={toc:l};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},i,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".GutenbergBlockProps"),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L62"},"packages/core/src/react/blocks/types.ts:62")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L61"},"packages/core/src/react/blocks/types.ts:61")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L60"},"packages/core/src/react/blocks/types.ts:60")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ae778953.6f8762d7.js b/assets/js/ae778953.282832d9.js similarity index 97% rename from assets/js/ae778953.6f8762d7.js rename to assets/js/ae778953.282832d9.js index b9f8216a6..b27e2517a 100644 --- a/assets/js/ae778953.6f8762d7.js +++ b/assets/js/ae778953.282832d9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9726],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function s(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var c=a.createContext({}),l=function(e){var t=a.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},p=function(e){var t=l(e.components);return a.createElement(c.Provider,{value:t},e.children)},h="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,c=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),h=l(r),d=n,m=h["".concat(c,".").concat(d)]||h[d]||u[d]||o;return r?a.createElement(m,s(s({ref:t},p),{},{components:r})):a.createElement(m,s({ref:t},p))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,s=new Array(o);s[0]=d;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i[h]="string"==typeof e?e:n,s[1]=i;for(var l=2;l{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>h,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var a=r(7462),n=(r(7294),r(3905));const o={slug:"/data-fetching/usesearch",sidebar_position:5},s="The useSearch hook",i={unversionedId:"Data Fetching/useSearch",id:"Data Fetching/useSearch",title:"The useSearch hook",description:"The useSearch hook is the Next.js binding for the useFetchSearch.",source:"@site/documentation/02 - Data Fetching/useSearch.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/usesearch",permalink:"/docs/learn/data-fetching/usesearch",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/useSearch.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",sidebarPosition:5,frontMatter:{slug:"/data-fetching/usesearch",sidebar_position:5},sidebar:"tutorialSidebar",previous:{title:"The useTerms hook",permalink:"/docs/learn/data-fetching/useterms"},next:{title:"The useSearchNative hook",permalink:"/docs/learn/data-fetching/usesearch-native"}},c={},l=[{value:"Basic Usage",id:"basic-usage",level:2},{value:"QueriedObject",id:"queriedobject",level:2},{value:"Known limitations",id:"known-limitations",level:2}],p={toc:l};function h(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("h1",{id:"the-usesearch-hook"},"The useSearch hook"),(0,n.kt)("blockquote",null,(0,n.kt)("p",{parentName:"blockquote"},"The ",(0,n.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next#usesearch"},"useSearch")," hook is the Next.js binding for the ",(0,n.kt)("a",{parentName:"p",href:"/api/namespaces/headstartwp_core.react#usefetchsearch"},"useFetchSearch"),".")),(0,n.kt)("p",null,"The ",(0,n.kt)("inlineCode",{parentName:"p"},"useSearch")," hook searches for WordPress posts from a registered post type."),(0,n.kt)("h2",{id:"basic-usage"},"Basic Usage"),(0,n.kt)("p",null,"Assuming a ",(0,n.kt)("inlineCode",{parentName:"p"},"src/pages/search/[[...path]].js")," route with the following content."),(0,n.kt)("admonition",{type:"info"},(0,n.kt)("p",{parentName:"admonition"},"This example is using the optional catch-all route ",(0,n.kt)("inlineCode",{parentName:"p"},"[[..path]].js")," because we want the ",(0,n.kt)("inlineCode",{parentName:"p"},"/search")," route to be handled by the same file and fetch the latest posts.")),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/search/[[...path]].js"',title:'"src/pages/search/[[...path]].js"'},"import { useSearch } from '@headstartwp/next';\n\nconst ArchivePage = () => {\n const { loading, error, data } = useSearch({ per_page: 10 });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n {data?.posts?.map((post) => (\n

{post.title.rendered}

\n ))}\n
\n );\n};\n")),(0,n.kt)("p",null,"The route will automatically render the latest 10 posts if no search term is provided. The following paths are automatically handled:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"/search/search-term"),(0,n.kt)("li",{parentName:"ul"},"/search/search-term/page/2"),(0,n.kt)("li",{parentName:"ul"},"/search")),(0,n.kt)("h2",{id:"queriedobject"},"QueriedObject"),(0,n.kt)("p",null,"The ",(0,n.kt)("inlineCode",{parentName:"p"},"useSearch")," hook also exposes a ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),". See ",(0,n.kt)("a",{parentName:"p",href:"/learn/data-fetching/useposts/#queried-object"},"usePosts docs")," for more info."),(0,n.kt)("p",null,"The queried object for for this hook is an object of type ",(0,n.kt)("a",{parentName:"p",href:"/api/interfaces/headstartwp_core.SearchEntity/"},"SearchEntity"),"."),(0,n.kt)("h2",{id:"known-limitations"},"Known limitations"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"It is not possible to fetch posts from more than one post type.")))}h.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9726],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function s(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var c=a.createContext({}),l=function(e){var t=a.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},p=function(e){var t=l(e.components);return a.createElement(c.Provider,{value:t},e.children)},h="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,c=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),h=l(r),d=n,m=h["".concat(c,".").concat(d)]||h[d]||u[d]||o;return r?a.createElement(m,s(s({ref:t},p),{},{components:r})):a.createElement(m,s({ref:t},p))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,s=new Array(o);s[0]=d;var i={};for(var c in t)hasOwnProperty.call(t,c)&&(i[c]=t[c]);i.originalType=e,i[h]="string"==typeof e?e:n,s[1]=i;for(var l=2;l{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>h,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var a=r(7462),n=(r(7294),r(3905));const o={slug:"/data-fetching/usesearch",sidebar_position:5},s="The useSearch hook",i={unversionedId:"Data Fetching/useSearch",id:"Data Fetching/useSearch",title:"The useSearch hook",description:"The useSearch hook is the Next.js binding for the useFetchSearch.",source:"@site/documentation/02 - Data Fetching/useSearch.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/usesearch",permalink:"/docs/learn/data-fetching/usesearch",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/useSearch.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",sidebarPosition:5,frontMatter:{slug:"/data-fetching/usesearch",sidebar_position:5},sidebar:"tutorialSidebar",previous:{title:"The useTerms hook",permalink:"/docs/learn/data-fetching/useterms"},next:{title:"The useSearchNative hook",permalink:"/docs/learn/data-fetching/usesearch-native"}},c={},l=[{value:"Basic Usage",id:"basic-usage",level:2},{value:"QueriedObject",id:"queriedobject",level:2},{value:"Known limitations",id:"known-limitations",level:2}],p={toc:l};function h(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("h1",{id:"the-usesearch-hook"},"The useSearch hook"),(0,n.kt)("blockquote",null,(0,n.kt)("p",{parentName:"blockquote"},"The ",(0,n.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next#usesearch"},"useSearch")," hook is the Next.js binding for the ",(0,n.kt)("a",{parentName:"p",href:"/api/namespaces/headstartwp_core.react#usefetchsearch"},"useFetchSearch"),".")),(0,n.kt)("p",null,"The ",(0,n.kt)("inlineCode",{parentName:"p"},"useSearch")," hook searches for WordPress posts from a registered post type."),(0,n.kt)("h2",{id:"basic-usage"},"Basic Usage"),(0,n.kt)("p",null,"Assuming a ",(0,n.kt)("inlineCode",{parentName:"p"},"src/pages/search/[[...path]].js")," route with the following content."),(0,n.kt)("admonition",{type:"info"},(0,n.kt)("p",{parentName:"admonition"},"This example is using the optional catch-all route ",(0,n.kt)("inlineCode",{parentName:"p"},"[[..path]].js")," because we want the ",(0,n.kt)("inlineCode",{parentName:"p"},"/search")," route to be handled by the same file and fetch the latest posts.")),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/search/[[...path]].js"',title:'"src/pages/search/[[...path]].js"'},"import { useSearch } from '@headstartwp/next';\n\nconst ArchivePage = () => {\n const { loading, error, data } = useSearch({ per_page: 10 });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n {data?.posts?.map((post) => (\n

{post.title.rendered}

\n ))}\n
\n );\n};\n")),(0,n.kt)("p",null,"The route will automatically render the latest 10 posts if no search term is provided. The following paths are automatically handled:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"/search/search-term"),(0,n.kt)("li",{parentName:"ul"},"/search/search-term/page/2"),(0,n.kt)("li",{parentName:"ul"},"/search")),(0,n.kt)("h2",{id:"queriedobject"},"QueriedObject"),(0,n.kt)("p",null,"The ",(0,n.kt)("inlineCode",{parentName:"p"},"useSearch")," hook also exposes a ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),". See ",(0,n.kt)("a",{parentName:"p",href:"/learn/data-fetching/useposts/#queried-object"},"usePosts docs")," for more info."),(0,n.kt)("p",null,"The queried object for for this hook is an object of type ",(0,n.kt)("a",{parentName:"p",href:"/api/interfaces/headstartwp_core.SearchEntity/"},"SearchEntity"),"."),(0,n.kt)("h2",{id:"known-limitations"},"Known limitations"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"It is not possible to fetch posts from more than one post type.")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b29fd792.d5a19c87.js b/assets/js/b29fd792.464af32e.js similarity index 96% rename from assets/js/b29fd792.d5a19c87.js rename to assets/js/b29fd792.464af32e.js index 5c1c13336..2a8bc70a6 100644 --- a/assets/js/b29fd792.d5a19c87.js +++ b/assets/js/b29fd792.464af32e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6048],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),c=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(o.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(o,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[s]="string"==typeof e?e:n,l[1]=p;for(var c=2;c{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>p,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.TableBlockProps",title:"Interface: TableBlockProps",sidebar_label:"@headstartwp/core.react.TableBlockProps",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.react.TableBlockProps",id:"interfaces/headstartwp_core.react.TableBlockProps",title:"Interface: TableBlockProps",description:"@headstartwp/core.react.TableBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.TableBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.TableBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.TableBlockProps",title:"Interface: TableBlockProps",sidebar_label:"@headstartwp/core.react.TableBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.StylesProperties",permalink:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"},next:{title:"@headstartwp/core.react.Typography",permalink:"/docs/api/interfaces/headstartwp_core.react.Typography"}},o={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"hasFixedLayout",id:"hasfixedlayout",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".TableBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"TableBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"hasfixedlayout"},"hasFixedLayout"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"hasFixedLayout"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/TableBlock.tsx#L7"},"packages/core/src/react/blocks/TableBlock.tsx:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6048],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),c=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(o.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(o,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[s]="string"==typeof e?e:n,l[1]=p;for(var c=2;c{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>p,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.TableBlockProps",title:"Interface: TableBlockProps",sidebar_label:"@headstartwp/core.react.TableBlockProps",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.react.TableBlockProps",id:"interfaces/headstartwp_core.react.TableBlockProps",title:"Interface: TableBlockProps",description:"@headstartwp/core.react.TableBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.TableBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.TableBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.TableBlockProps",title:"Interface: TableBlockProps",sidebar_label:"@headstartwp/core.react.TableBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.StylesProperties",permalink:"/docs/api/interfaces/headstartwp_core.react.StylesProperties"},next:{title:"@headstartwp/core.react.Typography",permalink:"/docs/api/interfaces/headstartwp_core.react.Typography"}},o={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"hasFixedLayout",id:"hasfixedlayout",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".TableBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"TableBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"hasfixedlayout"},"hasFixedLayout"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"hasFixedLayout"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/TableBlock.tsx#L7"},"packages/core/src/react/blocks/TableBlock.tsx:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b2b781c5.772b50e9.js b/assets/js/b2b781c5.c46620c0.js similarity index 97% rename from assets/js/b2b781c5.772b50e9.js rename to assets/js/b2b781c5.c46620c0.js index ab61fb649..76345d3c9 100644 --- a/assets/js/b2b781c5.772b50e9.js +++ b/assets/js/b2b781c5.c46620c0.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6563],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),c=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(o.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(o,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[s]="string"==typeof e?e:n,l[1]=p;for(var c=2;c{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>p,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.IBlock",title:"Interface: IBlock",sidebar_label:"@headstartwp/core.react.IBlock",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.react.IBlock",id:"interfaces/headstartwp_core.react.IBlock",title:"Interface: IBlock",description:"@headstartwp/core.react.IBlock",source:"@site/docs/interfaces/headstartwp_core.react.IBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IBlock",title:"Interface: IBlock",sidebar_label:"@headstartwp/core.react.IBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IAudioBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IAudioBlock"},next:{title:"@headstartwp/core.react.IBlockAttributes",permalink:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"}},o={},c=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("inlineCode",{parentName:"p"},"Omit"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.BlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"BlockProps")),", ",(0,n.kt)("inlineCode",{parentName:"p"},'"test"'),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IButtonBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IButtonBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IButtonsBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IButtonsBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IAudioBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IAudioBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ICodeBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"ICodeBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IColumnsBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IColumnsBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IColumnBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IColumnBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ICoverBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"ICoverBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IParagraphBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IParagraphBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IHeadingBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IHeadingBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IQuoteBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IQuoteBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IPullQuoteBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IPullQuoteBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IPreformattedBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IPreformattedBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IVerseBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IVerseBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ITableBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"ITableBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IGroupBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IGroupBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ISeparatorBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"ISeparatorBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ISpacerBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"ISpacerBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IListBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IListBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IYoutubeLiteBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IFileBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IFileBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IMediaTextBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IMediaTextBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IImageBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IImageBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,"Omit.children"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,"Omit.classList"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"T"),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,"Omit.domNode"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,"Omit.exclude"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,"Omit.style"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,"Omit.tagName"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6563],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),c=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(o.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=p(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(o,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},d),{},{components:a})):r.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[s]="string"==typeof e?e:n,l[1]=p;for(var c=2;c{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>p,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.IBlock",title:"Interface: IBlock",sidebar_label:"@headstartwp/core.react.IBlock",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.react.IBlock",id:"interfaces/headstartwp_core.react.IBlock",title:"Interface: IBlock",description:"@headstartwp/core.react.IBlock",source:"@site/docs/interfaces/headstartwp_core.react.IBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IBlock",title:"Interface: IBlock",sidebar_label:"@headstartwp/core.react.IBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IAudioBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IAudioBlock"},next:{title:"@headstartwp/core.react.IBlockAttributes",permalink:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"}},o={},c=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("inlineCode",{parentName:"p"},"Omit"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.BlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"BlockProps")),", ",(0,n.kt)("inlineCode",{parentName:"p"},'"test"'),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IButtonBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IButtonBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IButtonsBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IButtonsBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IAudioBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IAudioBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ICodeBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"ICodeBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IColumnsBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IColumnsBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IColumnBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IColumnBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ICoverBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"ICoverBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IParagraphBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IParagraphBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IHeadingBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IHeadingBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IQuoteBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IQuoteBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IPullQuoteBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IPullQuoteBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IPreformattedBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IPreformattedBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IVerseBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IVerseBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ITableBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"ITableBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IGroupBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IGroupBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ISeparatorBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"ISeparatorBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ISpacerBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"ISpacerBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IListBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IListBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IYoutubeLiteBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IFileBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IFileBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IMediaTextBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IMediaTextBlock"))),(0,n.kt)("p",{parentName:"li"},"\u21b3\u21b3 ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IImageBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IImageBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,"Omit.children"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,"Omit.classList"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"T"),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,"Omit.domNode"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,"Omit.exclude"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,"Omit.style"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,"Omit.tagName"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b2de5b9f.7e27c960.js b/assets/js/b2de5b9f.5bd6d8eb.js similarity index 93% rename from assets/js/b2de5b9f.7e27c960.js rename to assets/js/b2de5b9f.5bd6d8eb.js index 166b084b0..b501919bb 100644 --- a/assets/js/b2de5b9f.7e27c960.js +++ b/assets/js/b2de5b9f.5bd6d8eb.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9256],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>g});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var l=a.createContext({}),s=function(e){var t=a.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},c=function(e){var t=s(e.components);return a.createElement(l.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},f=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,l=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),d=s(r),f=n,g=d["".concat(l,".").concat(f)]||d[f]||u[f]||o;return r?a.createElement(g,i(i({ref:t},c),{},{components:r})):a.createElement(g,i({ref:t},c))}));function g(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,i=new Array(o);i[0]=f;var p={};for(var l in t)hasOwnProperty.call(t,l)&&(p[l]=t[l]);p.originalType=e,p[d]="string"==typeof e?e:n,i[1]=p;for(var s=2;s{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>p,toc:()=>s});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.PageInfo",title:"Interface: PageInfo",sidebar_label:"@headstartwp/core.PageInfo",custom_edit_url:null},i=void 0,p={unversionedId:"interfaces/headstartwp_core.PageInfo",id:"interfaces/headstartwp_core.PageInfo",title:"Interface: PageInfo",description:"@headstartwp/core.PageInfo",source:"@site/docs/interfaces/headstartwp_core.PageInfo.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PageInfo",permalink:"/docs/api/interfaces/headstartwp_core.PageInfo",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PageInfo",title:"Interface: PageInfo",sidebar_label:"@headstartwp/core.PageInfo",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PageEntity",permalink:"/docs/api/interfaces/headstartwp_core.PageEntity"},next:{title:"@headstartwp/core.PolylangIntegration",permalink:"/docs/api/interfaces/headstartwp_core.PolylangIntegration"}},l={},s=[{value:"Properties",id:"properties",level:2},{value:"page",id:"page",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"totalItems",id:"totalitems",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"totalPages",id:"totalpages",level:3},{value:"Defined in",id:"defined-in-2",level:4}],c={toc:s};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PageInfo"),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"page"},"page"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"page"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L757"},"packages/core/src/data/types/entities.ts:757")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"totalitems"},"totalItems"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"totalItems"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L756"},"packages/core/src/data/types/entities.ts:756")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"totalpages"},"totalPages"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"totalPages"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L755"},"packages/core/src/data/types/entities.ts:755")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9256],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>g});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var l=a.createContext({}),s=function(e){var t=a.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},c=function(e){var t=s(e.components);return a.createElement(l.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},f=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,l=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),d=s(r),f=n,g=d["".concat(l,".").concat(f)]||d[f]||u[f]||o;return r?a.createElement(g,i(i({ref:t},c),{},{components:r})):a.createElement(g,i({ref:t},c))}));function g(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,i=new Array(o);i[0]=f;var p={};for(var l in t)hasOwnProperty.call(t,l)&&(p[l]=t[l]);p.originalType=e,p[d]="string"==typeof e?e:n,i[1]=p;for(var s=2;s{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>p,toc:()=>s});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.PageInfo",title:"Interface: PageInfo",sidebar_label:"@headstartwp/core.PageInfo",custom_edit_url:null},i=void 0,p={unversionedId:"interfaces/headstartwp_core.PageInfo",id:"interfaces/headstartwp_core.PageInfo",title:"Interface: PageInfo",description:"@headstartwp/core.PageInfo",source:"@site/docs/interfaces/headstartwp_core.PageInfo.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PageInfo",permalink:"/docs/api/interfaces/headstartwp_core.PageInfo",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PageInfo",title:"Interface: PageInfo",sidebar_label:"@headstartwp/core.PageInfo",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PageEntity",permalink:"/docs/api/interfaces/headstartwp_core.PageEntity"},next:{title:"@headstartwp/core.PolylangIntegration",permalink:"/docs/api/interfaces/headstartwp_core.PolylangIntegration"}},l={},s=[{value:"Properties",id:"properties",level:2},{value:"page",id:"page",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"totalItems",id:"totalitems",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"totalPages",id:"totalpages",level:3},{value:"Defined in",id:"defined-in-2",level:4}],c={toc:s};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PageInfo"),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"page"},"page"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"page"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L757"},"packages/core/src/data/types/entities.ts:757")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"totalitems"},"totalItems"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"totalItems"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L756"},"packages/core/src/data/types/entities.ts:756")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"totalpages"},"totalPages"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"totalPages"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L755"},"packages/core/src/data/types/entities.ts:755")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/bd37eed7.814f8d13.js b/assets/js/bd37eed7.51aad78e.js similarity index 96% rename from assets/js/bd37eed7.814f8d13.js rename to assets/js/bd37eed7.51aad78e.js index 622e26681..c91a784d3 100644 --- a/assets/js/bd37eed7.814f8d13.js +++ b/assets/js/bd37eed7.51aad78e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6593],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),d=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},c=function(e){var t=d(e.components);return n.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),s=d(a),m=r,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return a?n.createElement(h,l(l({ref:t},c),{},{components:a})):n.createElement(h,l({ref:t},c))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:r,l[1]=o;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.react.IHeadingBlock",title:"Interface: IHeadingBlock",sidebar_label:"@headstartwp/core.react.IHeadingBlock",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.IHeadingBlock",id:"interfaces/headstartwp_core.react.IHeadingBlock",title:"Interface: IHeadingBlock",description:"@headstartwp/core.react.IHeadingBlock",source:"@site/docs/interfaces/headstartwp_core.react.IHeadingBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IHeadingBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IHeadingBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IHeadingBlock",title:"Interface: IHeadingBlock",sidebar_label:"@headstartwp/core.react.IHeadingBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IGroupBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IGroupBlock"},next:{title:"@headstartwp/core.react.IImageBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IImageBlock"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],c={toc:d};function s(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IHeadingBlock"),(0,r.kt)("p",null,"The common interface for a block transform component"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadingBlockProps")),">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"IHeadingBlock"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"children"},"children"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"children"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,r.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,r.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classlist"},"classList"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"classList"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classname"},"className"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"className"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"component"},"component"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"component"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadingBlockProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadingBlockProps")))))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domnode"},"domNode"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"domNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,r.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,r.kt)("h5",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"childNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h5",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"style"},"style"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"style"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The style tag of the domNode as an object."),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tagname"},"tagName"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tagName"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6593],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),d=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},c=function(e){var t=d(e.components);return n.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),s=d(a),m=r,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return a?n.createElement(h,l(l({ref:t},c),{},{components:a})):n.createElement(h,l({ref:t},c))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:r,l[1]=o;for(var d=2;d{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.react.IHeadingBlock",title:"Interface: IHeadingBlock",sidebar_label:"@headstartwp/core.react.IHeadingBlock",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.IHeadingBlock",id:"interfaces/headstartwp_core.react.IHeadingBlock",title:"Interface: IHeadingBlock",description:"@headstartwp/core.react.IHeadingBlock",source:"@site/docs/interfaces/headstartwp_core.react.IHeadingBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IHeadingBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IHeadingBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IHeadingBlock",title:"Interface: IHeadingBlock",sidebar_label:"@headstartwp/core.react.IHeadingBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IGroupBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IGroupBlock"},next:{title:"@headstartwp/core.react.IImageBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IImageBlock"}},p={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],c={toc:d};function s(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IHeadingBlock"),(0,r.kt)("p",null,"The common interface for a block transform component"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadingBlockProps")),">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"IHeadingBlock"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"children"},"children"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"children"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,r.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,r.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classlist"},"classList"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"classList"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classname"},"className"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"className"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"component"},"component"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"component"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadingBlockProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadingBlockProps")))))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domnode"},"domNode"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"domNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,r.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,r.kt)("h5",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"childNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h5",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"style"},"style"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"style"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The style tag of the domNode as an object."),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tagname"},"tagName"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tagName"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/bdcbc508.2f8634b7.js b/assets/js/bdcbc508.2f8634b7.js deleted file mode 100644 index de103750a..000000000 --- a/assets/js/bdcbc508.2f8634b7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8039],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function s(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var i=r.createContext({}),d=function(e){var t=r.useContext(i),a=t;return e&&(a="function"==typeof e?e(t):s(s({},t),e)),a},c=function(e){var t=d(e.components);return r.createElement(i.Provider,{value:t},e.children)},l="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,i=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),l=d(a),u=n,h=l["".concat(i,".").concat(u)]||l[u]||k[u]||o;return a?r.createElement(h,s(s({ref:t},c),{},{components:a})):r.createElement(h,s({ref:t},c))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,s=new Array(o);s[0]=u;var p={};for(var i in t)hasOwnProperty.call(t,i)&&(p[i]=t[i]);p.originalType=e,p[l]="string"==typeof e?e:n,s[1]=p;for(var d=2;d{a.r(t),a.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>p,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const o={id:"headstartwp_core.react.usePostsResponse",title:"Interface: usePostsResponse",sidebar_label:"@headstartwp/core.react.usePostsResponse",custom_edit_url:null},s=void 0,p={unversionedId:"interfaces/headstartwp_core.react.usePostsResponse",id:"interfaces/headstartwp_core.react.usePostsResponse",title:"Interface: usePostsResponse",description:"@headstartwp/core.react.usePostsResponse",source:"@site/docs/interfaces/headstartwp_core.react.usePostsResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.usePostsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.usePostsResponse",title:"Interface: usePostsResponse",sidebar_label:"@headstartwp/core.react.usePostsResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.usePostResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostResponse"},next:{title:"@headstartwp/core.react.useSearchNativeResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useSearchNativeResponse"}},i={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"pageType",id:"pagetype",level:3},{value:"Defined in",id:"defined-in-4",level:4}],c={toc:d};function l(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".usePostsResponse"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"usePostsResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"pageInfo")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"posts")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"queriedObject")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject")))))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/useFetchPosts.ts#L59"},"packages/core/src/react/hooks/useFetchPosts.ts:59")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"pagetype"},"pageType"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"pageType"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#pagetype"},(0,n.kt)("inlineCode",{parentName:"a"},"PageType"))),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/useFetchPosts.ts#L64"},"packages/core/src/react/hooks/useFetchPosts.ts:64")))}l.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/bdcbc508.5ff73dcd.js b/assets/js/bdcbc508.5ff73dcd.js new file mode 100644 index 000000000..de1cec497 --- /dev/null +++ b/assets/js/bdcbc508.5ff73dcd.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8039],{3905:(e,t,a)=>{a.d(t,{Zo:()=>l,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function s(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function o(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var i=r.createContext({}),d=function(e){var t=r.useContext(i),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},l=function(e){var t=d(e.components);return r.createElement(i.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,s=e.originalType,i=e.parentName,l=p(e,["components","mdxType","originalType","parentName"]),c=d(a),u=n,h=c["".concat(i,".").concat(u)]||c[u]||k[u]||s;return a?r.createElement(h,o(o({ref:t},l),{},{components:a})):r.createElement(h,o({ref:t},l))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var s=a.length,o=new Array(s);o[0]=u;var p={};for(var i in t)hasOwnProperty.call(t,i)&&(p[i]=t[i]);p.originalType=e,p[c]="string"==typeof e?e:n,o[1]=p;for(var d=2;d{a.r(t),a.d(t,{assets:()=>i,contentTitle:()=>o,default:()=>c,frontMatter:()=>s,metadata:()=>p,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const s={id:"headstartwp_core.react.usePostsResponse",title:"Interface: usePostsResponse",sidebar_label:"@headstartwp/core.react.usePostsResponse",custom_edit_url:null},o=void 0,p={unversionedId:"interfaces/headstartwp_core.react.usePostsResponse",id:"interfaces/headstartwp_core.react.usePostsResponse",title:"Interface: usePostsResponse",description:"@headstartwp/core.react.usePostsResponse",source:"@site/docs/interfaces/headstartwp_core.react.usePostsResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.usePostsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.usePostsResponse",title:"Interface: usePostsResponse",sidebar_label:"@headstartwp/core.react.usePostsResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.usePostResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostResponse"},next:{title:"@headstartwp/core.react.useSearchNativeResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useSearchNativeResponse"}},i={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"mutate",id:"mutate",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"pageType",id:"pagetype",level:3},{value:"Defined in",id:"defined-in-5",level:4}],l={toc:d};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},l,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".usePostsResponse"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"usePostsResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"pageInfo")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"posts")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"queriedObject")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject")))))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetchPosts.ts#L60"},"packages/core/src/react/hooks/useFetchPosts.ts:60")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"mutate"},"mutate"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"mutate"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"KeyedMutator"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetchPosts.ts#L66"},"packages/core/src/react/hooks/useFetchPosts.ts:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"pagetype"},"pageType"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"pageType"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#pagetype"},(0,n.kt)("inlineCode",{parentName:"a"},"PageType"))),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetchPosts.ts#L65"},"packages/core/src/react/hooks/useFetchPosts.ts:65")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c0c5ccb8.568eada1.js b/assets/js/c0c5ccb8.4907e4d4.js similarity index 97% rename from assets/js/c0c5ccb8.568eada1.js rename to assets/js/c0c5ccb8.4907e4d4.js index f6f9ec8cd..55475c0b6 100644 --- a/assets/js/c0c5ccb8.568eada1.js +++ b/assets/js/c0c5ccb8.4907e4d4.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7721],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var s=n.createContext({}),c=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},p=function(e){var t=c(e.components);return n.createElement(s.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),u=c(r),f=a,m=u["".concat(s,".").concat(f)]||u[f]||d[f]||i;return r?n.createElement(m,o(o({ref:t},p),{},{components:r})):n.createElement(m,o({ref:t},p))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,o=new Array(i);o[0]=f;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[u]="string"==typeof e?e:a,o[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var n=r(7462),a=(r(7294),r(3905));const i={},o="Linaria (CSS-in-JS)",l={unversionedId:"Guides/linaria",id:"Guides/linaria",title:"Linaria (CSS-in-JS)",description:"HeadstartWP offers a straightforward integration with Linaria, a zero-runtime CSS-in-JS solution. To use it, simply install the following linaria packages.",source:"@site/documentation/08-Guides/linaria.md",sourceDirName:"08-Guides",slug:"/Guides/linaria",permalink:"/docs/learn/Guides/linaria",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/08-Guides/linaria.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"A/B Test SPA vs MPA navigation",permalink:"/docs/learn/Guides/ab-test-link"},next:{title:"TypeScript",permalink:"/docs/learn/Guides/typescript"}},s={},c=[],p={toc:c};function u(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"linaria-css-in-js"},"Linaria (CSS-in-JS)"),(0,a.kt)("p",null,"HeadstartWP offers a straightforward integration with ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/callstack/linaria"},"Linaria"),", a zero-runtime CSS-in-JS solution. To use it, simply install the following linaria packages."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"npm install --save-dev @linaria/babel-preset @linaria/core @linaria/react @linaria/shaker @linaria/webpack-loader\n")),(0,a.kt)("p",null,"The ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_next.config/#withheadstartwpconfig"},"withHeadstartWPConfig")," function will detect the presence of the Linaria packages and will enable the build steps necessary to compile Linaria."),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"If you're on a monorepo setup, these packages should be installed on the Next.js project.")))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7721],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function o(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var s=n.createContext({}),c=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},p=function(e){var t=c(e.components);return n.createElement(s.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),u=c(r),f=a,m=u["".concat(s,".").concat(f)]||u[f]||d[f]||i;return r?n.createElement(m,o(o({ref:t},p),{},{components:r})):n.createElement(m,o({ref:t},p))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=r.length,o=new Array(i);o[0]=f;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[u]="string"==typeof e?e:a,o[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>o,default:()=>u,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var n=r(7462),a=(r(7294),r(3905));const i={},o="Linaria (CSS-in-JS)",l={unversionedId:"Guides/linaria",id:"Guides/linaria",title:"Linaria (CSS-in-JS)",description:"HeadstartWP offers a straightforward integration with Linaria, a zero-runtime CSS-in-JS solution. To use it, simply install the following linaria packages.",source:"@site/documentation/08-Guides/linaria.md",sourceDirName:"08-Guides",slug:"/Guides/linaria",permalink:"/docs/learn/Guides/linaria",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/08-Guides/linaria.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",frontMatter:{},sidebar:"tutorialSidebar",previous:{title:"A/B Test SPA vs MPA navigation",permalink:"/docs/learn/Guides/ab-test-link"},next:{title:"TypeScript",permalink:"/docs/learn/Guides/typescript"}},s={},c=[],p={toc:c};function u(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"linaria-css-in-js"},"Linaria (CSS-in-JS)"),(0,a.kt)("p",null,"HeadstartWP offers a straightforward integration with ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/callstack/linaria"},"Linaria"),", a zero-runtime CSS-in-JS solution. To use it, simply install the following linaria packages."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"npm install --save-dev @linaria/babel-preset @linaria/core @linaria/react @linaria/shaker @linaria/webpack-loader\n")),(0,a.kt)("p",null,"The ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_next.config/#withheadstartwpconfig"},"withHeadstartWPConfig")," function will detect the presence of the Linaria packages and will enable the build steps necessary to compile Linaria."),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"If you're on a monorepo setup, these packages should be installed on the Next.js project.")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c10c719f.fdef7864.js b/assets/js/c10c719f.532abfcc.js similarity index 93% rename from assets/js/c10c719f.fdef7864.js rename to assets/js/c10c719f.532abfcc.js index 507d279a6..8f5b532bb 100644 --- a/assets/js/c10c719f.fdef7864.js +++ b/assets/js/c10c719f.532abfcc.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9956],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>g});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),d=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=d(e.components);return a.createElement(p.Provider,{value:t},e.children)},c="mdxType",f={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),c=d(n),m=r,g=c["".concat(p,".").concat(m)]||c[m]||f[m]||i;return n?a.createElement(g,l(l({ref:t},s),{},{components:n})):a.createElement(g,l({ref:t},s))}));function g(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[c]="string"==typeof e?e:r,l[1]=o;for(var d=2;d{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var a=n(7462),r=(n(7294),n(3905));const i={id:"headstartwp_next.config",title:"Namespace: config",sidebar_label:"@headstartwp/next.config",custom_edit_url:null},l=void 0,o={unversionedId:"namespaces/headstartwp_next.config",id:"namespaces/headstartwp_next.config",title:"Namespace: config",description:"@headstartwp/next.config",source:"@site/docs/namespaces/headstartwp_next.config.md",sourceDirName:"namespaces",slug:"/namespaces/headstartwp_next.config",permalink:"/docs/api/namespaces/headstartwp_next.config",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_next.config",title:"Namespace: config",sidebar_label:"@headstartwp/next.config",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react",permalink:"/docs/api/namespaces/headstartwp_core.react"},next:{title:"@headstartwp/next.middlewares",permalink:"/docs/api/namespaces/headstartwp_next.middlewares"}},p={},d=[{value:"@headstartwp/next/config",id:"headstartwpnextconfig",level:2},{value:"Usage",id:"usage",level:3},{value:"Functions",id:"functions",level:2},{value:"withHeadlessConfig",id:"withheadlessconfig",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"withHeadstartWPConfig",id:"withheadstartwpconfig",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4}],s={toc:d};function c(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next"},"@headstartwp/next"),".config"),(0,r.kt)("h2",{id:"headstartwpnextconfig"},"@headstartwp/next/config"),(0,r.kt)("p",null,"The config export of the ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/next")," package."),(0,r.kt)("h3",{id:"usage"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { withHeadlessConfig } from '@headstartwp/next/config';\n")),(0,r.kt)("h2",{id:"functions"},"Functions"),(0,r.kt)("h3",{id:"withheadlessconfig"},"withHeadlessConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"withHeadlessConfig"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"nextConfig?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"headlessConfig?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"withHeadstarWPConfigOptions?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"NextConfig")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"nextConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"NextConfig"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"headlessConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"HeadlessConfig"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"withHeadstarWPConfigOptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"withHeadstarWPConfigOptions.injectConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"NextConfig")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/config/withHeadstartWPConfig.ts#L268"},"packages/next/src/config/withHeadstartWPConfig.ts:268")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"withheadstartwpconfig"},"withHeadstartWPConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"withHeadstartWPConfig"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"nextConfig?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"headlessConfig?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"withHeadstarWPConfigOptions?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"NextConfig")),(0,r.kt)("p",null,"HOC used to wrap the nextjs config object with the headless config object."),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"nextConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"NextConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The nextjs config object")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"headlessConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"HeadlessConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The headless config")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"withHeadstarWPConfigOptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object")),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"withHeadstarWPConfigOptions.injectConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"NextConfig")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/config/withHeadstartWPConfig.ts#L58"},"packages/next/src/config/withHeadstartWPConfig.ts:58")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9956],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>g});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),d=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=d(e.components);return a.createElement(p.Provider,{value:t},e.children)},f="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,p=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),f=d(n),m=r,g=f["".concat(p,".").concat(m)]||f[m]||c[m]||i;return n?a.createElement(g,l(l({ref:t},s),{},{components:n})):a.createElement(g,l({ref:t},s))}));function g(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[f]="string"==typeof e?e:r,l[1]=o;for(var d=2;d{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>f,frontMatter:()=>i,metadata:()=>o,toc:()=>d});var a=n(7462),r=(n(7294),n(3905));const i={id:"headstartwp_next.config",title:"Namespace: config",sidebar_label:"@headstartwp/next.config",custom_edit_url:null},l=void 0,o={unversionedId:"namespaces/headstartwp_next.config",id:"namespaces/headstartwp_next.config",title:"Namespace: config",description:"@headstartwp/next.config",source:"@site/docs/namespaces/headstartwp_next.config.md",sourceDirName:"namespaces",slug:"/namespaces/headstartwp_next.config",permalink:"/docs/api/namespaces/headstartwp_next.config",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_next.config",title:"Namespace: config",sidebar_label:"@headstartwp/next.config",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react",permalink:"/docs/api/namespaces/headstartwp_core.react"},next:{title:"@headstartwp/next.middlewares",permalink:"/docs/api/namespaces/headstartwp_next.middlewares"}},p={},d=[{value:"@headstartwp/next/config",id:"headstartwpnextconfig",level:2},{value:"Usage",id:"usage",level:3},{value:"Functions",id:"functions",level:2},{value:"withHeadlessConfig",id:"withheadlessconfig",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"withHeadstartWPConfig",id:"withheadstartwpconfig",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4}],s={toc:d};function f(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next"},"@headstartwp/next"),".config"),(0,r.kt)("h2",{id:"headstartwpnextconfig"},"@headstartwp/next/config"),(0,r.kt)("p",null,"The config export of the ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/next")," package."),(0,r.kt)("h3",{id:"usage"},"Usage"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-tsx"},"import { withHeadlessConfig } from '@headstartwp/next/config';\n")),(0,r.kt)("h2",{id:"functions"},"Functions"),(0,r.kt)("h3",{id:"withheadlessconfig"},"withHeadlessConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"withHeadlessConfig"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"nextConfig?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"headlessConfig?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"withHeadstarWPConfigOptions?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"NextConfig")),(0,r.kt)("h4",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"nextConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"NextConfig"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"headlessConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"HeadlessConfig"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"withHeadstarWPConfigOptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"withHeadstarWPConfigOptions.injectConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean"))))),(0,r.kt)("h4",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"NextConfig")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/config/withHeadstartWPConfig.ts#L268"},"packages/next/src/config/withHeadstartWPConfig.ts:268")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"withheadstartwpconfig"},"withHeadstartWPConfig"),(0,r.kt)("p",null,"\u25b8 ",(0,r.kt)("strong",{parentName:"p"},"withHeadstartWPConfig"),"(",(0,r.kt)("inlineCode",{parentName:"p"},"nextConfig?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"headlessConfig?"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"withHeadstarWPConfigOptions?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"NextConfig")),(0,r.kt)("p",null,"HOC used to wrap the nextjs config object with the headless config object."),(0,r.kt)("h4",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"nextConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"NextConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The nextjs config object")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"headlessConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"HeadlessConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},"The headless config")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"withHeadstarWPConfigOptions")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"Object")),(0,r.kt)("td",{parentName:"tr",align:"left"})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"withHeadstarWPConfigOptions.injectConfig")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:"left"},"-")))),(0,r.kt)("h4",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"NextConfig")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/config/withHeadstartWPConfig.ts#L58"},"packages/next/src/config/withHeadstartWPConfig.ts:58")))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c4bf4659.7317e6e3.js b/assets/js/c4bf4659.52c994d2.js similarity index 91% rename from assets/js/c4bf4659.7317e6e3.js rename to assets/js/c4bf4659.52c994d2.js index 6b08f0a9e..1551d3023 100644 --- a/assets/js/c4bf4659.7317e6e3.js +++ b/assets/js/c4bf4659.52c994d2.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[856],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function p(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var c=a.createContext({}),o=function(e){var t=a.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):p(p({},t),e)),r},d=function(e){var t=o(e.components);return a.createElement(c.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,c=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),s=o(r),m=n,h=s["".concat(c,".").concat(m)]||s[m]||k[m]||i;return r?a.createElement(h,p(p({ref:t},d),{},{components:r})):a.createElement(h,p({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,p=new Array(i);p[0]=m;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l[s]="string"==typeof e?e:n,p[1]=l;for(var o=2;o{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>p,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>o});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.SpacerBlockProps",title:"Interface: SpacerBlockProps",sidebar_label:"@headstartwp/core.react.SpacerBlockProps",custom_edit_url:null},p=void 0,l={unversionedId:"interfaces/headstartwp_core.react.SpacerBlockProps",id:"interfaces/headstartwp_core.react.SpacerBlockProps",title:"Interface: SpacerBlockProps",description:"@headstartwp/core.react.SpacerBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.SpacerBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.SpacerBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.SpacerBlockProps",title:"Interface: SpacerBlockProps",sidebar_label:"@headstartwp/core.react.SpacerBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.SettingsProperties",permalink:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},next:{title:"@headstartwp/core.react.StylesElementsPropertiesComplete",permalink:"/docs/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete"}},c={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"height",id:"height",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:o};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".SpacerBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"SpacerBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"height"},"height"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"height"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/SpacerBlock.tsx#L7"},"packages/core/src/react/blocks/SpacerBlock.tsx:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[856],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function p(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var o=a.createContext({}),c=function(e){var t=a.useContext(o),r=t;return e&&(r="function"==typeof e?e(t):p(p({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(o.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),s=c(r),m=n,h=s["".concat(o,".").concat(m)]||s[m]||k[m]||i;return r?a.createElement(h,p(p({ref:t},d),{},{components:r})):a.createElement(h,p({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,p=new Array(i);p[0]=m;var l={};for(var o in t)hasOwnProperty.call(t,o)&&(l[o]=t[o]);l.originalType=e,l[s]="string"==typeof e?e:n,p[1]=l;for(var c=2;c{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>p,default:()=>s,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.SpacerBlockProps",title:"Interface: SpacerBlockProps",sidebar_label:"@headstartwp/core.react.SpacerBlockProps",custom_edit_url:null},p=void 0,l={unversionedId:"interfaces/headstartwp_core.react.SpacerBlockProps",id:"interfaces/headstartwp_core.react.SpacerBlockProps",title:"Interface: SpacerBlockProps",description:"@headstartwp/core.react.SpacerBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.SpacerBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.SpacerBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.SpacerBlockProps",title:"Interface: SpacerBlockProps",sidebar_label:"@headstartwp/core.react.SpacerBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.SettingsProperties",permalink:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties"},next:{title:"@headstartwp/core.react.StylesElementsPropertiesComplete",permalink:"/docs/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete"}},o={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"height",id:"height",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".SpacerBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"SpacerBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"height"},"height"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"height"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/SpacerBlock.tsx#L7"},"packages/core/src/react/blocks/SpacerBlock.tsx:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c75a8848.043380e5.js b/assets/js/c75a8848.a3dc555a.js similarity index 97% rename from assets/js/c75a8848.043380e5.js rename to assets/js/c75a8848.a3dc555a.js index 03ac2a9c4..2d72926e8 100644 --- a/assets/js/c75a8848.043380e5.js +++ b/assets/js/c75a8848.a3dc555a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3435],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var l=r.createContext({}),d=function(e){var t=r.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=d(e.components);return r.createElement(l.Provider,{value:t},e.children)},h="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,l=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),h=d(a),m=n,k=h["".concat(l,".").concat(m)]||h[m]||c[m]||i;return a?r.createElement(k,p(p({ref:t},o),{},{components:a})):r.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[h]="string"==typeof e?e:n,p[1]=s;for(var d=2;d{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>h,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.AuthorArchiveFetchStrategy",title:"Class: AuthorArchiveFetchStrategy",sidebar_label:"@headstartwp/core.AuthorArchiveFetchStrategy",custom_edit_url:null},p=void 0,s={unversionedId:"classes/headstartwp_core.AuthorArchiveFetchStrategy",id:"classes/headstartwp_core.AuthorArchiveFetchStrategy",title:"Class: AuthorArchiveFetchStrategy",description:"@headstartwp/core.AuthorArchiveFetchStrategy",source:"@site/docs/classes/headstartwp_core.AuthorArchiveFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.AuthorArchiveFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.AuthorArchiveFetchStrategy",title:"Class: AuthorArchiveFetchStrategy",sidebar_label:"@headstartwp/core.AuthorArchiveFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.AppSettingsStrategy",permalink:"/docs/api/classes/headstartwp_core.AppSettingsStrategy"},next:{title:"@headstartwp/core.Comment",permalink:"/docs/api/classes/headstartwp_core.Comment"}},l={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"locale",id:"locale",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"path",id:"path",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getPreviewAuthHeader",id:"getpreviewauthheader",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"getPreviewHeaderName",id:"getpreviewheadername",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-22",level:4},{value:"Defined in",id:"defined-in-23",level:4}],o={toc:d};function h(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".AuthorArchiveFetchStrategy"),(0,n.kt)("p",null,"The AuthorArchiveFetchStrategy extends the ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy")," and performs author archive requests"),(0,n.kt)("p",null,"This strategy supports extracting endpoint params from url E.g:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/author-name/")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ author: 'author-name' }")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/author-name/page/2")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ author: 'author-name', page: 2 }"))),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"AuthorArchiveFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new AuthorArchiveFetchStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L143"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:143")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L119"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:119")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L124"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:124")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"locale"},"locale"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"locale"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#locale"},"locale")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L212"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:212")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"path"},"path"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"path"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#path"},"path")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L210"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:210")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Handles taxonomy filters and switch endpoint based on post type"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint with")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L289"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:289")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"Before fetching posts, we need handle taxonomy and authors."),(0,n.kt)("p",null,"If the headless plugin is not being used, then additional requests needs to be made to get\nauthors and terms ids"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL to parse")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint with")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"FetchOptions")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L393"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:393")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L530"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:530")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L442"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:442")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L256"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:256")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L407"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:407")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L214"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:214")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L218"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:218")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L174"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:174")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"This strategy automatically extracts taxonomy filters, date filters and pagination params from the URL"),(0,n.kt)("p",null,"It also takes into account the custom taxonomies specified in ",(0,n.kt)("inlineCode",{parentName:"p"},"headless.config.js")),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL path to extract params from")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"})))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AuthorArchiveFetchStrategy.ts#L20"},"packages/core/src/data/strategies/AuthorArchiveFetchStrategy.ts:20")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewauthheader"},"getPreviewAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getpreviewauthheader"},"getPreviewAuthHeader")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L247"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:247")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewheadername"},"getPreviewHeaderName"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewHeaderName"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getpreviewheadername"},"getPreviewHeaderName")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L241"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:241")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))),(0,n.kt)("p",null,"Returns the queried object if applicable (e.g if querying by category, tag, author or custom taxonomy term)"),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The response from the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))),(0,n.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L461"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:461")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L205"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:205")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-19"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L417"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:417")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"inherited-from-20"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L327"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:327")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-14"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-16"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-21"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L164"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:164")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-15"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-17"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-22"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")))}h.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3435],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>k});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var l=r.createContext({}),d=function(e){var t=r.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=d(e.components);return r.createElement(l.Provider,{value:t},e.children)},h="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,l=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),h=d(a),m=n,k=h["".concat(l,".").concat(m)]||h[m]||c[m]||i;return a?r.createElement(k,p(p({ref:t},o),{},{components:a})):r.createElement(k,p({ref:t},o))}));function k(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[h]="string"==typeof e?e:n,p[1]=s;for(var d=2;d{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>h,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.AuthorArchiveFetchStrategy",title:"Class: AuthorArchiveFetchStrategy",sidebar_label:"@headstartwp/core.AuthorArchiveFetchStrategy",custom_edit_url:null},p=void 0,s={unversionedId:"classes/headstartwp_core.AuthorArchiveFetchStrategy",id:"classes/headstartwp_core.AuthorArchiveFetchStrategy",title:"Class: AuthorArchiveFetchStrategy",description:"@headstartwp/core.AuthorArchiveFetchStrategy",source:"@site/docs/classes/headstartwp_core.AuthorArchiveFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.AuthorArchiveFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.AuthorArchiveFetchStrategy",title:"Class: AuthorArchiveFetchStrategy",sidebar_label:"@headstartwp/core.AuthorArchiveFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.AppSettingsStrategy",permalink:"/docs/api/classes/headstartwp_core.AppSettingsStrategy"},next:{title:"@headstartwp/core.Comment",permalink:"/docs/api/classes/headstartwp_core.Comment"}},l={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"locale",id:"locale",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"path",id:"path",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-9",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getPreviewAuthHeader",id:"getpreviewauthheader",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"getPreviewHeaderName",id:"getpreviewheadername",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-18",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-19",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-20",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Inherited from",id:"inherited-from-21",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-22",level:4},{value:"Defined in",id:"defined-in-23",level:4}],o={toc:d};function h(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".AuthorArchiveFetchStrategy"),(0,n.kt)("p",null,"The AuthorArchiveFetchStrategy extends the ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy")," and performs author archive requests"),(0,n.kt)("p",null,"This strategy supports extracting endpoint params from url E.g:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/author-name/")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ author: 'author-name' }")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"/author-name/page/2")," maps to ",(0,n.kt)("inlineCode",{parentName:"li"},"{ author: 'author-name', page: 2 }"))),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"AuthorArchiveFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new AuthorArchiveFetchStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L143"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:143")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L119"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:119")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L124"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:124")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"locale"},"locale"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"locale"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#locale"},"locale")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L212"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:212")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"path"},"path"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"path"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#path"},"path")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L210"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:210")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Handles taxonomy filters and switch endpoint based on post type"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint with")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L289"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:289")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"Before fetching posts, we need handle taxonomy and authors."),(0,n.kt)("p",null,"If the headless plugin is not being used, then additional requests needs to be made to get\nauthors and terms ids"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL to parse")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to build the endpoint with")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"FetchOptions")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L393"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:393")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L530"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:530")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">",">"),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L442"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:442")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L256"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:256")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L407"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:407")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L214"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:214")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L218"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:218")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L174"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:174")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"This strategy automatically extracts taxonomy filters, date filters and pagination params from the URL"),(0,n.kt)("p",null,"It also takes into account the custom taxonomies specified in ",(0,n.kt)("inlineCode",{parentName:"p"},"headless.config.js")),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL path to extract params from")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"})))),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AuthorArchiveFetchStrategy.ts#L20"},"packages/core/src/data/strategies/AuthorArchiveFetchStrategy.ts:20")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewauthheader"},"getPreviewAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getpreviewauthheader"},"getPreviewAuthHeader")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L247"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:247")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewheadername"},"getPreviewHeaderName"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewHeaderName"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getpreviewheadername"},"getPreviewHeaderName")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L241"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:241")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))),(0,n.kt)("p",null,"Returns the queried object if applicable (e.g if querying by category, tag, author or custom taxonomy term)"),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The response from the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))),(0,n.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L461"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:461")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-18"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L205"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:205")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-19"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L417"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:417")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]",">"),(0,n.kt)("h4",{id:"inherited-from-20"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts#L327"},"packages/core/src/data/strategies/PostsArchiveFetchStrategy.ts:327")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-14"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-16"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-21"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L164"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:164")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-15"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-17"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-22"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},"PostsArchiveFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c969edca.bf153f0c.js b/assets/js/c969edca.38d8f92e.js similarity index 96% rename from assets/js/c969edca.bf153f0c.js rename to assets/js/c969edca.38d8f92e.js index a9395ae04..84057cbdf 100644 --- a/assets/js/c969edca.bf153f0c.js +++ b/assets/js/c969edca.38d8f92e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[313],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function s(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},l=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},f=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,l=i(e,["components","mdxType","originalType","parentName"]),d=c(r),f=n,h=d["".concat(p,".").concat(f)]||d[f]||u[f]||o;return r?a.createElement(h,s(s({ref:t},l),{},{components:r})):a.createElement(h,s({ref:t},l))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,s=new Array(o);s[0]=f;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[d]="string"==typeof e?e:n,s[1]=i;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.FetchResponse",title:"Interface: FetchResponse",sidebar_label:"@headstartwp/core.FetchResponse",custom_edit_url:null},s=void 0,i={unversionedId:"interfaces/headstartwp_core.FetchResponse",id:"interfaces/headstartwp_core.FetchResponse",title:"Interface: FetchResponse",description:"@headstartwp/core.FetchResponse",source:"@site/docs/interfaces/headstartwp_core.FetchResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.FetchResponse",permalink:"/docs/api/interfaces/headstartwp_core.FetchResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.FetchResponse",title:"Interface: FetchResponse",sidebar_label:"@headstartwp/core.FetchResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.FetchOptions",permalink:"/docs/api/interfaces/headstartwp_core.FetchOptions"},next:{title:"@headstartwp/core.FilterDataOptions",permalink:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"}},p={},c=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"pageInfo",id:"pageinfo",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"queriedObject",id:"queriedobject",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"result",id:"result",level:3},{value:"Defined in",id:"defined-in-2",level:4}],l={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".FetchResponse"),(0,n.kt)("p",null,"The type of the fetch response"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"pageinfo"},"pageInfo"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))),(0,n.kt)("p",null,"Contains pagination information"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L46"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:46")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"queriedobject"},"queriedObject"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))),(0,n.kt)("p",null,"Queried Object information"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L51"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:51")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"result"},"result"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"T")),(0,n.kt)("p",null,"Contains the actual data returned from the API"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L41"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:41")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[313],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function s(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},l=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},f=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,l=i(e,["components","mdxType","originalType","parentName"]),d=c(r),f=n,h=d["".concat(p,".").concat(f)]||d[f]||u[f]||o;return r?a.createElement(h,s(s({ref:t},l),{},{components:r})):a.createElement(h,s({ref:t},l))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,s=new Array(o);s[0]=f;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[d]="string"==typeof e?e:n,s[1]=i;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.FetchResponse",title:"Interface: FetchResponse",sidebar_label:"@headstartwp/core.FetchResponse",custom_edit_url:null},s=void 0,i={unversionedId:"interfaces/headstartwp_core.FetchResponse",id:"interfaces/headstartwp_core.FetchResponse",title:"Interface: FetchResponse",description:"@headstartwp/core.FetchResponse",source:"@site/docs/interfaces/headstartwp_core.FetchResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.FetchResponse",permalink:"/docs/api/interfaces/headstartwp_core.FetchResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.FetchResponse",title:"Interface: FetchResponse",sidebar_label:"@headstartwp/core.FetchResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.FetchOptions",permalink:"/docs/api/interfaces/headstartwp_core.FetchOptions"},next:{title:"@headstartwp/core.FilterDataOptions",permalink:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"}},p={},c=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"pageInfo",id:"pageinfo",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"queriedObject",id:"queriedobject",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"result",id:"result",level:3},{value:"Defined in",id:"defined-in-2",level:4}],l={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".FetchResponse"),(0,n.kt)("p",null,"The type of the fetch response"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"pageinfo"},"pageInfo"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))),(0,n.kt)("p",null,"Contains pagination information"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L46"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:46")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"queriedobject"},"queriedObject"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))),(0,n.kt)("p",null,"Queried Object information"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L51"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:51")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"result"},"result"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"T")),(0,n.kt)("p",null,"Contains the actual data returned from the API"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L41"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:41")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c9e017d7.297cbbaa.js b/assets/js/c9e017d7.453b0e5d.js similarity index 98% rename from assets/js/c9e017d7.297cbbaa.js rename to assets/js/c9e017d7.453b0e5d.js index 3385dd3fb..9b7875266 100644 --- a/assets/js/c9e017d7.297cbbaa.js +++ b/assets/js/c9e017d7.453b0e5d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4038],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>u});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var o=a.createContext({}),p=function(e){var t=a.useContext(o),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=p(e.components);return a.createElement(o.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),c=p(r),m=n,u=c["".concat(o,".").concat(m)]||c[m]||k[m]||i;return r?a.createElement(u,l(l({ref:t},s),{},{components:r})):a.createElement(u,l({ref:t},s))}));function u(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=m;var d={};for(var o in t)hasOwnProperty.call(t,o)&&(d[o]=t[o]);d.originalType=e,d[c]="string"==typeof e?e:n,l[1]=d;for(var p=2;p{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>d,toc:()=>p});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.FetchError",title:"Class: FetchError",sidebar_label:"@headstartwp/core.FetchError",custom_edit_url:null},l=void 0,d={unversionedId:"classes/headstartwp_core.FetchError",id:"classes/headstartwp_core.FetchError",title:"Class: FetchError",description:"@headstartwp/core.FetchError",source:"@site/docs/classes/headstartwp_core.FetchError.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.FetchError",permalink:"/docs/api/classes/headstartwp_core.FetchError",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.FetchError",title:"Class: FetchError",sidebar_label:"@headstartwp/core.FetchError",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.EndpointError",permalink:"/docs/api/classes/headstartwp_core.EndpointError"},next:{title:"@headstartwp/core.FrameworkError",permalink:"/docs/api/classes/headstartwp_core.FrameworkError"}},o={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"cause",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"stack",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"prepareStackTrace",id:"preparestacktrace",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],s={toc:p};function c(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".FetchError"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("inlineCode",{parentName:"p"},"Error")),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"FetchError"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new FetchError"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"message"),")"),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"message")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,"Error.constructor"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/utils/errors.ts#L11"},"packages/core/src/utils/errors.ts:11")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"cause"},"cause"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"cause"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,"Error.cause"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"message"},"message"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"message"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,"Error.message"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1054"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,"Error.name"),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1053"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"stack"},"stack"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"stack"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,"Error.stack"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1055"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:127"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"preparestacktrace"},"prepareStackTrace"),(0,n.kt)("p",null,"\u25aa ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"prepareStackTrace"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"err"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"stackTraces"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"CallSite"),"[]) => ",(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"err"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"stackTraces"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("p",null,"Optional override for formatting stack traces"),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"See"))),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces"},"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces")),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"err")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Error"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"stackTraces")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"CallSite"),"[]")))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,"Error.prepareStackTrace"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:140"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"stacktracelimit"},"stackTraceLimit"),(0,n.kt)("p",null,"\u25aa ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("strong",{parentName:"p"},"stackTraceLimit"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,"Error.stackTraceLimit"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:142"),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"capturestacktrace"},"captureStackTrace"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("strong",{parentName:"p"},"captureStackTrace"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"targetObject"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"constructorOpt?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"Create .stack property on a target object"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"targetObject")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Object"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"constructorOpt?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Function"))))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,"Error.captureStackTrace"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:133"))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4038],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>u});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var o=a.createContext({}),p=function(e){var t=a.useContext(o),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=p(e.components);return a.createElement(o.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,s=d(e,["components","mdxType","originalType","parentName"]),c=p(r),m=n,u=c["".concat(o,".").concat(m)]||c[m]||k[m]||i;return r?a.createElement(u,l(l({ref:t},s),{},{components:r})):a.createElement(u,l({ref:t},s))}));function u(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=m;var d={};for(var o in t)hasOwnProperty.call(t,o)&&(d[o]=t[o]);d.originalType=e,d[c]="string"==typeof e?e:n,l[1]=d;for(var p=2;p{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>d,toc:()=>p});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.FetchError",title:"Class: FetchError",sidebar_label:"@headstartwp/core.FetchError",custom_edit_url:null},l=void 0,d={unversionedId:"classes/headstartwp_core.FetchError",id:"classes/headstartwp_core.FetchError",title:"Class: FetchError",description:"@headstartwp/core.FetchError",source:"@site/docs/classes/headstartwp_core.FetchError.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.FetchError",permalink:"/docs/api/classes/headstartwp_core.FetchError",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.FetchError",title:"Class: FetchError",sidebar_label:"@headstartwp/core.FetchError",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.EndpointError",permalink:"/docs/api/classes/headstartwp_core.EndpointError"},next:{title:"@headstartwp/core.FrameworkError",permalink:"/docs/api/classes/headstartwp_core.FrameworkError"}},o={},p=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"cause",id:"cause",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"stack",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"prepareStackTrace",id:"preparestacktrace",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4}],s={toc:p};function c(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".FetchError"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("inlineCode",{parentName:"p"},"Error")),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"FetchError"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new FetchError"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"message"),")"),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"message")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,"Error.constructor"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/utils/errors.ts#L11"},"packages/core/src/utils/errors.ts:11")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"cause"},"cause"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"cause"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"unknown")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,"Error.cause"),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"message"},"message"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"message"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,"Error.message"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1054"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,"Error.name"),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1053"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"stack"},"stack"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"stack"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,"Error.stack"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,"docs/node_modules/typescript/lib/lib.es5.d.ts:1055"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:127"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"preparestacktrace"},"prepareStackTrace"),(0,n.kt)("p",null,"\u25aa ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"prepareStackTrace"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"err"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Error"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"stackTraces"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"CallSite"),"[]) => ",(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"err"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"stackTraces"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("p",null,"Optional override for formatting stack traces"),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"See"))),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces"},"https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces")),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"err")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Error"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"stackTraces")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"CallSite"),"[]")))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"any")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,"Error.prepareStackTrace"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:140"),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"stacktracelimit"},"stackTraceLimit"),(0,n.kt)("p",null,"\u25aa ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("strong",{parentName:"p"},"stackTraceLimit"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,"Error.stackTraceLimit"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:142"),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"capturestacktrace"},"captureStackTrace"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("inlineCode",{parentName:"p"},"Static")," ",(0,n.kt)("strong",{parentName:"p"},"captureStackTrace"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"targetObject"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"constructorOpt?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"Create .stack property on a target object"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"targetObject")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Object"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"constructorOpt?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Function"))))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,"Error.captureStackTrace"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,"node_modules/@types/node/globals.d.ts:133"))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/cb8267fc.f060b419.js b/assets/js/cb8267fc.d8c8563f.js similarity index 98% rename from assets/js/cb8267fc.f060b419.js rename to assets/js/cb8267fc.d8c8563f.js index 748e3eb39..0ef26a4a9 100644 --- a/assets/js/cb8267fc.f060b419.js +++ b/assets/js/cb8267fc.d8c8563f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7625],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>w});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function d(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var d=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),s=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},o=function(e){var t=s(e.components);return r.createElement(p.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,d=e.originalType,p=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),c=s(a),u=n,w=c["".concat(p,".").concat(u)]||c[u]||m[u]||d;return a?r.createElement(w,i(i({ref:t},o),{},{components:a})):r.createElement(w,i({ref:t},o))}));function w(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var d=a.length,i=new Array(d);i[0]=u;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[c]="string"==typeof e?e:n,i[1]=l;for(var s=2;s{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>c,frontMatter:()=>d,metadata:()=>l,toc:()=>s});var r=a(7462),n=(a(7294),a(3905));const d={id:"headstartwp_next.middlewares",title:"Namespace: middlewares",sidebar_label:"@headstartwp/next.middlewares",custom_edit_url:null},i=void 0,l={unversionedId:"namespaces/headstartwp_next.middlewares",id:"namespaces/headstartwp_next.middlewares",title:"Namespace: middlewares",description:"@headstartwp/next.middlewares",source:"@site/docs/namespaces/headstartwp_next.middlewares.md",sourceDirName:"namespaces",slug:"/namespaces/headstartwp_next.middlewares",permalink:"/docs/api/namespaces/headstartwp_next.middlewares",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_next.middlewares",title:"Namespace: middlewares",sidebar_label:"@headstartwp/next.middlewares",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/next.config",permalink:"/docs/api/namespaces/headstartwp_next.config"},next:{title:"@headstartwp/core.LOGTYPE",permalink:"/docs/api/enums/headstartwp_core.LOGTYPE"}},p={},s=[{value:"@headstartwp/next/middlewares",id:"headstartwpnextmiddlewares",level:2},{value:"Usage",id:"usage",level:3},{value:"Functions",id:"functions",level:2},{value:"AppMiddleware",id:"appmiddleware",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4}],o={toc:s};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next"},"@headstartwp/next"),".middlewares"),(0,n.kt)("h2",{id:"headstartwpnextmiddlewares"},"@headstartwp/next/middlewares"),(0,n.kt)("p",null,"The middlewares export of the `@headstartwp/next' package."),(0,n.kt)("h3",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { appMiddleware } from '@headstartwp/next/middlewares';\n")),(0,n.kt)("h2",{id:"functions"},"Functions"),(0,n.kt)("h3",{id:"appmiddleware"},"AppMiddleware"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"AppMiddleware"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"req"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"NextResponse"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"unknown"),">",">"),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"req")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"NextRequest"))))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"NextResponse"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"unknown"),">",">"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/next/src/middlewares/appMidleware.ts#L15"},"packages/next/src/middlewares/appMidleware.ts:15")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7625],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>w});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function d(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var d=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),s=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},o=function(e){var t=s(e.components);return r.createElement(p.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,d=e.originalType,p=e.parentName,o=l(e,["components","mdxType","originalType","parentName"]),c=s(a),u=n,w=c["".concat(p,".").concat(u)]||c[u]||m[u]||d;return a?r.createElement(w,i(i({ref:t},o),{},{components:a})):r.createElement(w,i({ref:t},o))}));function w(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var d=a.length,i=new Array(d);i[0]=u;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[c]="string"==typeof e?e:n,i[1]=l;for(var s=2;s{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>c,frontMatter:()=>d,metadata:()=>l,toc:()=>s});var r=a(7462),n=(a(7294),a(3905));const d={id:"headstartwp_next.middlewares",title:"Namespace: middlewares",sidebar_label:"@headstartwp/next.middlewares",custom_edit_url:null},i=void 0,l={unversionedId:"namespaces/headstartwp_next.middlewares",id:"namespaces/headstartwp_next.middlewares",title:"Namespace: middlewares",description:"@headstartwp/next.middlewares",source:"@site/docs/namespaces/headstartwp_next.middlewares.md",sourceDirName:"namespaces",slug:"/namespaces/headstartwp_next.middlewares",permalink:"/docs/api/namespaces/headstartwp_next.middlewares",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_next.middlewares",title:"Namespace: middlewares",sidebar_label:"@headstartwp/next.middlewares",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/next.config",permalink:"/docs/api/namespaces/headstartwp_next.config"},next:{title:"@headstartwp/core.LOGTYPE",permalink:"/docs/api/enums/headstartwp_core.LOGTYPE"}},p={},s=[{value:"@headstartwp/next/middlewares",id:"headstartwpnextmiddlewares",level:2},{value:"Usage",id:"usage",level:3},{value:"Functions",id:"functions",level:2},{value:"AppMiddleware",id:"appmiddleware",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4}],o={toc:s};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_next"},"@headstartwp/next"),".middlewares"),(0,n.kt)("h2",{id:"headstartwpnextmiddlewares"},"@headstartwp/next/middlewares"),(0,n.kt)("p",null,"The middlewares export of the `@headstartwp/next' package."),(0,n.kt)("h3",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { appMiddleware } from '@headstartwp/next/middlewares';\n")),(0,n.kt)("h2",{id:"functions"},"Functions"),(0,n.kt)("h3",{id:"appmiddleware"},"AppMiddleware"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"AppMiddleware"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"req"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"NextResponse"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"unknown"),">",">"),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"req")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"NextRequest"))))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"NextResponse"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"unknown"),">",">"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/next/src/middlewares/appMidleware.ts#L15"},"packages/next/src/middlewares/appMidleware.ts:15")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/cf8aa22f.e0f462e8.js b/assets/js/cf8aa22f.c8ec3807.js similarity index 94% rename from assets/js/cf8aa22f.e0f462e8.js rename to assets/js/cf8aa22f.c8ec3807.js index cc0fc44d7..939c49585 100644 --- a/assets/js/cf8aa22f.e0f462e8.js +++ b/assets/js/cf8aa22f.c8ec3807.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9236],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>k});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function s(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),o=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):s(s({},t),e)),a},d=function(e){var t=o(e.components);return r.createElement(p.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),c=o(a),u=n,k=c["".concat(p,".").concat(u)]||c[u]||h[u]||i;return a?r.createElement(k,s(s({ref:t},d),{},{components:a})):r.createElement(k,s({ref:t},d))}));function k(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,s=new Array(i);s[0]=u;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[c]="string"==typeof e?e:n,s[1]=l;for(var o=2;o{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>o});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.PostParams",title:"Interface: PostParams",sidebar_label:"@headstartwp/core.PostParams",custom_edit_url:null},s=void 0,l={unversionedId:"interfaces/headstartwp_core.PostParams",id:"interfaces/headstartwp_core.PostParams",title:"Interface: PostParams",description:"@headstartwp/core.PostParams",source:"@site/docs/interfaces/headstartwp_core.PostParams.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PostParams",permalink:"/docs/api/interfaces/headstartwp_core.PostParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostParams",title:"Interface: PostParams",sidebar_label:"@headstartwp/core.PostParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PostOrPostsParams",permalink:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},next:{title:"@headstartwp/core.PostSearchEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"}},p={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embed",id:"_embed",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"_fields",id:"_fields",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"authToken",id:"authtoken",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"fullPath",id:"fullpath",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"lang",id:"lang",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"matchCurrentPath",id:"matchcurrentpath",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"postType",id:"posttype",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"revision",id:"revision",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-9",level:4}],d={toc:o};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostParams"),(0,n.kt)("p",null,"The EndpointParams supported by the ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy"},"SinglePostFetchStrategy")),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"PostParams"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"_embed"},"_","embed"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","embed"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"The _embed param returned associated entities in the response"),(0,n.kt)("p",null,"It's recommended to avoid additional requests to fetch data"),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_embed"},"_embed")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L17"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:17")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"_fields"},"_","fields"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","fields"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The _fields parameter is used to return only the specified fields in the response"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_fields"},"_fields")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L22"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:22")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"authtoken"},"authToken"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"authToken"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The authToken, required to fetch revisions or non-published posts"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L53"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fullpath"},"fullPath"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"fullPath"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"If set, this is the path that will be checked if ",(0,n.kt)("inlineCode",{parentName:"p"},"slug")," is set or ",(0,n.kt)("inlineCode",{parentName:"p"},"matchCurrentPath")," is set to true."),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L63"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:63")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"id"},"id"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"id"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Number")),(0,n.kt)("p",null,"Fetch post by id"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L43"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:43")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"lang"},"lang"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"lang"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The polylang ?lang parameter."),(0,n.kt)("p",null,"This is only used if the polylang integration is enabled"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#lang"},"lang")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L29"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:29")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"matchcurrentpath"},"matchCurrentPath"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"matchCurrentPath"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Whether post.link should be checked against current path"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L58"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"posttype"},"postType"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"postType"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"Post Types where we should look for"),(0,n.kt)("p",null,"If multiple post types are specified\nmultiple requests will be issued to each post type until a matching post is found"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L38"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:38")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"revision"},"revision"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"revision"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Boolean")),(0,n.kt)("p",null,"If set will fetch the latest post revision"),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L48"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:48")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"slug"},"slug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"slug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The slug of the post to fetch"),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L30"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:30")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9236],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>k});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function s(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),o=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):s(s({},t),e)),a},d=function(e){var t=o(e.components);return r.createElement(p.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},u=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),c=o(a),u=n,k=c["".concat(p,".").concat(u)]||c[u]||h[u]||i;return a?r.createElement(k,s(s({ref:t},d),{},{components:a})):r.createElement(k,s({ref:t},d))}));function k(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,s=new Array(i);s[0]=u;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[c]="string"==typeof e?e:n,s[1]=l;for(var o=2;o{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>c,frontMatter:()=>i,metadata:()=>l,toc:()=>o});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.PostParams",title:"Interface: PostParams",sidebar_label:"@headstartwp/core.PostParams",custom_edit_url:null},s=void 0,l={unversionedId:"interfaces/headstartwp_core.PostParams",id:"interfaces/headstartwp_core.PostParams",title:"Interface: PostParams",description:"@headstartwp/core.PostParams",source:"@site/docs/interfaces/headstartwp_core.PostParams.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.PostParams",permalink:"/docs/api/interfaces/headstartwp_core.PostParams",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostParams",title:"Interface: PostParams",sidebar_label:"@headstartwp/core.PostParams",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.PostOrPostsParams",permalink:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},next:{title:"@headstartwp/core.PostSearchEntity",permalink:"/docs/api/interfaces/headstartwp_core.PostSearchEntity"}},p={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embed",id:"_embed",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"_fields",id:"_fields",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"authToken",id:"authtoken",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"fullPath",id:"fullpath",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"id",id:"id",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"lang",id:"lang",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"matchCurrentPath",id:"matchcurrentpath",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"postType",id:"posttype",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"revision",id:"revision",level:3},{value:"Defined in",id:"defined-in-8",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-9",level:4}],d={toc:o};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostParams"),(0,n.kt)("p",null,"The EndpointParams supported by the ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy"},"SinglePostFetchStrategy")),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},(0,n.kt)("inlineCode",{parentName:"a"},"EndpointParams"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"PostParams"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"_embed"},"_","embed"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","embed"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"The _embed param returned associated entities in the response"),(0,n.kt)("p",null,"It's recommended to avoid additional requests to fetch data"),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_embed"},"_embed")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L17"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:17")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"_fields"},"_","fields"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"_","fields"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The _fields parameter is used to return only the specified fields in the response"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#_fields"},"_fields")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L22"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:22")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"authtoken"},"authToken"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"authToken"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The authToken, required to fetch revisions or non-published posts"),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L53"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fullpath"},"fullPath"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"fullPath"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"If set, this is the path that will be checked if ",(0,n.kt)("inlineCode",{parentName:"p"},"slug")," is set or ",(0,n.kt)("inlineCode",{parentName:"p"},"matchCurrentPath")," is set to true."),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L63"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:63")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"id"},"id"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"id"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Number")),(0,n.kt)("p",null,"Fetch post by id"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L43"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:43")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"lang"},"lang"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"lang"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The polylang ?lang parameter."),(0,n.kt)("p",null,"This is only used if the polylang integration is enabled"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams"},"EndpointParams"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.EndpointParams#lang"},"lang")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L29"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:29")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"matchcurrentpath"},"matchCurrentPath"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"matchCurrentPath"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Whether post.link should be checked against current path"),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L58"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"posttype"},"postType"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"postType"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"Post Types where we should look for"),(0,n.kt)("p",null,"If multiple post types are specified\nmultiple requests will be issued to each post type until a matching post is found"),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L38"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:38")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"revision"},"revision"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"revision"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Boolean")),(0,n.kt)("p",null,"If set will fetch the latest post revision"),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L48"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:48")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"slug"},"slug"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"slug"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The slug of the post to fetch"),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/SinglePostFetchStrategy.ts#L30"},"packages/core/src/data/strategies/SinglePostFetchStrategy.ts:30")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/cfec6fcb.79617c0d.js b/assets/js/cfec6fcb.6ddba869.js similarity index 98% rename from assets/js/cfec6fcb.79617c0d.js rename to assets/js/cfec6fcb.6ddba869.js index 02344fc85..9ab6a31fc 100644 --- a/assets/js/cfec6fcb.79617c0d.js +++ b/assets/js/cfec6fcb.6ddba869.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9953],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>g});var a=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var s=a.createContext({}),c=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},d=function(e){var t=c(e.components);return a.createElement(s.Provider,{value:t},e.children)},p="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,o=e.mdxType,r=e.originalType,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),p=c(n),u=o,g=p["".concat(s,".").concat(u)]||p[u]||h[u]||r;return n?a.createElement(g,i(i({ref:t},d),{},{components:n})):a.createElement(g,i({ref:t},d))}));function g(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var r=n.length,i=new Array(r);i[0]=u;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[p]="string"==typeof e?e:o,i[1]=l;for(var c=2;c{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>p,frontMatter:()=>r,metadata:()=>l,toc:()=>c});var a=n(7462),o=(n(7294),n(3905));const r={sidebar_label:"Rendering Blocks in React Native",slug:"/gutenberg/rendering-blocks-in-react-native"},i="Rendering Blocks in React Native",l={unversionedId:"Gutenberg/rendering-blocks-in-react-native",id:"Gutenberg/rendering-blocks-in-react-native",title:"Rendering Blocks in React Native",description:"Introduction",source:"@site/documentation/05-Gutenberg/rendering-blocks-in-react-native.md",sourceDirName:"05-Gutenberg",slug:"/gutenberg/rendering-blocks-in-react-native",permalink:"/docs/learn/gutenberg/rendering-blocks-in-react-native",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/05-Gutenberg/rendering-blocks-in-react-native.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",frontMatter:{sidebar_label:"Rendering Blocks in React Native",slug:"/gutenberg/rendering-blocks-in-react-native"},sidebar:"tutorialSidebar",previous:{title:"Rendering Custom Blocks",permalink:"/docs/learn/gutenberg/rendering-custom-blocks"},next:{title:"Previews",permalink:"/docs/learn/wordpress-integration/previews"}},s={},c=[{value:"Introduction",id:"introduction",level:2},{value:"Blocks Rendering",id:"blocks-rendering",level:2},{value:"Paragraph Block",id:"paragraph-block",level:2},{value:"Heading Block",id:"heading-block",level:2},{value:"Image Block",id:"image-block",level:2},{value:"Result",id:"result",level:2}],d={toc:c};function p(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"rendering-blocks-in-react-native"},"Rendering Blocks in React Native"),(0,o.kt)("h2",{id:"introduction"},"Introduction"),(0,o.kt)("p",null,"The BlocksRenderer component can also be used to render Gutenberg blocks in React Native, by rendering blocks to native components without using a webview."),(0,o.kt)("p",null,"The examples in this section are part of a demo react native expo hosted on the ",(0,o.kt)("a",{parentName:"p",href:"https://github.com/nicholasio/headless-expo"},"headless-expo")," repo. This Demo app uses expo and the HeadstartWP to fetch a page and render Gutenberg blocks as react-native components."),(0,o.kt)("p",null,"All of the code for this demo app lives in ",(0,o.kt)("a",{parentName:"p",href:"https://github.com/nicholasio/headless-expo/blob/trunk/App.js"},"App.js"),". Since the demo app is using the data-fetching hooks from the core package, we first need to wrap the App with the SettingsProvider component."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'export default function App() {\n return (\n \n \n \n \n \n \n );\n}\n')),(0,o.kt)("p",null,"We also need to inject the headless config. For now, we need to use a workaround to inject the headless config."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'import headlessConfig from "./headless.config";\n\nglobalThis.__10up__HEADLESS_CONFIG = { ...headlessConfig };\n')),(0,o.kt)("h2",{id:"blocks-rendering"},"Blocks Rendering"),(0,o.kt)("p",null,"The SinglePostComponent is the one that fetches a page and render its content"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'function SinglePostComponent() {\n const { loading, data } = useFetchPost({\n postType: "page",\n slug: "react-native-test",\n });\n\n if (loading) {\n return Loading...;\n }\n\n return (\n \n \n \n \n \n \n \n );\n}\n')),(0,o.kt)("p",null,'useFetchPost is the core implementation of the usePost. The next.js hooks are built on top of the core data-fetching hooks. The core data-fetching hooks can be used in any react environment. In this example, we\u2019re fetching a page, with a slug called "react-native-test".'),(0,o.kt)("p",null,"This is all we need to have a React Native app that fetches data from a WP instance. The next step is building out the Block components."),(0,o.kt)("p",null,"We\u2019ll start with EmptyBlock and RawText. We need to be very careful when rendering blocks in React Native as we can\u2019t render any text under a React Native View component and remember that ",(0,o.kt)("strong",{parentName:"p"},"we\u2019re not rendering this under a webview, we are rendering blocks as native components.")),(0,o.kt)("p",null,"Since we can\u2019t render blocks that haven\u2019t been implemented by us yet, we\u2019ll create an allowed block list! We\u2019ll do that in the EmptyBlock component."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'/**\n * A noop block\n *\n * You can also use this to create a "allowList" of blocks and ignore blocks you don\'t want to render\n *\n * @returns\n */\nconst EmptyBlock = () => <>;\n\nEmptyBlock.defaultProps = {\n /**\n * Essentially catches any empty text nodes to make sure they don\'t get rendered under a component\n *\n * @param {*} node\n * @returns\n */\n test: (node) => {\n const allowedBlocks = ["core/paragraph", "core/heading", "core/image"];\n\n // if this isn\'t an allowed block catch it\n // if this is an allowed block it should have been handled at this ppint\n if (\n node.type !== "text" &&\n !allowedBlocks.some((blockName) => isBlockByName(node, blockName))\n ) {\n return true;\n }\n\n return (\n node.type === "text" &&\n (node.parent === null || node.data?.trim().length === 0)\n );\n },\n};\n')),(0,o.kt)("p",null,"The goal of the EmptyBlock is to catch all non-allowed blocks and skip rendering them at all. Additionally, it also catches orphan text nodes that only contain whitespaces (this would catch things carriage returns, spacing around tags, etc\u2026)"),(0,o.kt)("p",null,"Note that we\u2019re using defaultProps to provide the test function. This has the same result of passing the test function as a prop directly."),(0,o.kt)("p",null,"The next step is implementing a RawText component."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'/**\n * Trims raw text nodes\n *\n * @param {*} param0\n * @returns\n */\nconst RawText = ({ domNode }) => {\n return domNode.data.trim();\n};\n\nRawText.defaultProps = {\n /**\n * Catches any non-orphans and non-empty text fields\n *\n * @param {*} node\n * @returns\n */\n test: (node) =>\n node.type === "text" &&\n node.parent !== null &&\n node.data?.trim().length >= 0,\n};\n')),(0,o.kt)("p",null,'The goal here is to trim all text nodes. This is mostly to clean up text nodes. Therefore, we catch any non-orphans and non-empty text field nodes and replace them with a "trimmed" version.'),(0,o.kt)("p",null,"Now we have ensured that we don\u2019t have lingering text nodes and that valid text node does not contain additional whitespaces at the beginning and end."),(0,o.kt)("h2",{id:"paragraph-block"},"Paragraph Block"),(0,o.kt)("p",null,"Implementing the Paragraph block is pretty simple. All we need to do is use the React Native Text component"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'import { /* ... */, Text} from "react-native";\n\nconst RNParagraphBlock = ({ children }) => {\n return {children};\n};\n')),(0,o.kt)("p",null,'Note that this is essentially replacing the "p" tag with a native "Text" component. "children" in this context represent text nodes that are processed via the "RawText" block. If we didn\u2019t render children here, RawText block would never be executed for this paragraph. It\u2019s recursive logic!'),(0,o.kt)("h2",{id:"heading-block"},"Heading Block"),(0,o.kt)("p",null,'The heading block is very similar, we leverage the "level" prop that\u2019s automatically passed by the HeadingBlock component. We use it to create a dynamic class name that contains the style for the heading.'),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'import { /* ... */, Text} from "react-native";\n\nconst RNHeadingBlock = ({ children, level }) => {\n return {children};\n};\n\nconst styles = StyleSheet.create({\n container: {\n flex: 1,\n backgroundColor: "#fff",\n alignItems: "center",\n justifyContent: "center",\n },\n headingLevel1: {\n fontWeight: "bold",\n fontSize: "26px",\n },\n headingLevel2: {\n fontWeight: "bold",\n fontSize: "20px",\n },\n});\n')),(0,o.kt)("h2",{id:"image-block"},"Image Block"),(0,o.kt)("p",null,'The last block we\u2019ll implement is the image block. It is a bit more complex but it first captures the image caption by looping through the DOM node children until it finds a "figcaption" Then it uses the "height", "width" and "src" props that are automatically passed by the ImageBlock component to render the image using the native "Image" component.'),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'import { /* ... */, Image, Text} from "react-native";\n\nconst RNImageBlock = ({ domNode, height, width, src }) => {\n const caption =\n domNode.children.find((el) => el.name === "figcaption")?.firstChild?.data ??\n "";\n return (\n <>\n \n {caption}\n \n );\n};\n')),(0,o.kt)("h2",{id:"result"},"Result"),(0,o.kt)("p",null,"The demo app should render something like this"),(0,o.kt)("p",null,(0,o.kt)("img",{alt:"Blocks App",src:n(1264).Z,width:"495",height:"1024"})))}p.isMDXComponent=!0},1264:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/blocks-app-8e0dc4891e16eece268a8dd31d9b9564.png"}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9953],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>g});var a=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var s=a.createContext({}),c=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},d=function(e){var t=c(e.components);return a.createElement(s.Provider,{value:t},e.children)},p="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,o=e.mdxType,r=e.originalType,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),p=c(n),u=o,g=p["".concat(s,".").concat(u)]||p[u]||h[u]||r;return n?a.createElement(g,i(i({ref:t},d),{},{components:n})):a.createElement(g,i({ref:t},d))}));function g(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var r=n.length,i=new Array(r);i[0]=u;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[p]="string"==typeof e?e:o,i[1]=l;for(var c=2;c{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>p,frontMatter:()=>r,metadata:()=>l,toc:()=>c});var a=n(7462),o=(n(7294),n(3905));const r={sidebar_label:"Rendering Blocks in React Native",slug:"/gutenberg/rendering-blocks-in-react-native"},i="Rendering Blocks in React Native",l={unversionedId:"Gutenberg/rendering-blocks-in-react-native",id:"Gutenberg/rendering-blocks-in-react-native",title:"Rendering Blocks in React Native",description:"Introduction",source:"@site/documentation/05-Gutenberg/rendering-blocks-in-react-native.md",sourceDirName:"05-Gutenberg",slug:"/gutenberg/rendering-blocks-in-react-native",permalink:"/docs/learn/gutenberg/rendering-blocks-in-react-native",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/05-Gutenberg/rendering-blocks-in-react-native.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",frontMatter:{sidebar_label:"Rendering Blocks in React Native",slug:"/gutenberg/rendering-blocks-in-react-native"},sidebar:"tutorialSidebar",previous:{title:"Rendering Custom Blocks",permalink:"/docs/learn/gutenberg/rendering-custom-blocks"},next:{title:"Previews",permalink:"/docs/learn/wordpress-integration/previews"}},s={},c=[{value:"Introduction",id:"introduction",level:2},{value:"Blocks Rendering",id:"blocks-rendering",level:2},{value:"Paragraph Block",id:"paragraph-block",level:2},{value:"Heading Block",id:"heading-block",level:2},{value:"Image Block",id:"image-block",level:2},{value:"Result",id:"result",level:2}],d={toc:c};function p(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"rendering-blocks-in-react-native"},"Rendering Blocks in React Native"),(0,o.kt)("h2",{id:"introduction"},"Introduction"),(0,o.kt)("p",null,"The BlocksRenderer component can also be used to render Gutenberg blocks in React Native, by rendering blocks to native components without using a webview."),(0,o.kt)("p",null,"The examples in this section are part of a demo react native expo hosted on the ",(0,o.kt)("a",{parentName:"p",href:"https://github.com/nicholasio/headless-expo"},"headless-expo")," repo. This Demo app uses expo and the HeadstartWP to fetch a page and render Gutenberg blocks as react-native components."),(0,o.kt)("p",null,"All of the code for this demo app lives in ",(0,o.kt)("a",{parentName:"p",href:"https://github.com/nicholasio/headless-expo/blob/trunk/App.js"},"App.js"),". Since the demo app is using the data-fetching hooks from the core package, we first need to wrap the App with the SettingsProvider component."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'export default function App() {\n return (\n \n \n \n \n \n \n );\n}\n')),(0,o.kt)("p",null,"We also need to inject the headless config. For now, we need to use a workaround to inject the headless config."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'import headlessConfig from "./headless.config";\n\nglobalThis.__10up__HEADLESS_CONFIG = { ...headlessConfig };\n')),(0,o.kt)("h2",{id:"blocks-rendering"},"Blocks Rendering"),(0,o.kt)("p",null,"The SinglePostComponent is the one that fetches a page and render its content"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'function SinglePostComponent() {\n const { loading, data } = useFetchPost({\n postType: "page",\n slug: "react-native-test",\n });\n\n if (loading) {\n return Loading...;\n }\n\n return (\n \n \n \n \n \n \n \n );\n}\n')),(0,o.kt)("p",null,'useFetchPost is the core implementation of the usePost. The next.js hooks are built on top of the core data-fetching hooks. The core data-fetching hooks can be used in any react environment. In this example, we\u2019re fetching a page, with a slug called "react-native-test".'),(0,o.kt)("p",null,"This is all we need to have a React Native app that fetches data from a WP instance. The next step is building out the Block components."),(0,o.kt)("p",null,"We\u2019ll start with EmptyBlock and RawText. We need to be very careful when rendering blocks in React Native as we can\u2019t render any text under a React Native View component and remember that ",(0,o.kt)("strong",{parentName:"p"},"we\u2019re not rendering this under a webview, we are rendering blocks as native components.")),(0,o.kt)("p",null,"Since we can\u2019t render blocks that haven\u2019t been implemented by us yet, we\u2019ll create an allowed block list! We\u2019ll do that in the EmptyBlock component."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'/**\n * A noop block\n *\n * You can also use this to create a "allowList" of blocks and ignore blocks you don\'t want to render\n *\n * @returns\n */\nconst EmptyBlock = () => <>;\n\nEmptyBlock.defaultProps = {\n /**\n * Essentially catches any empty text nodes to make sure they don\'t get rendered under a component\n *\n * @param {*} node\n * @returns\n */\n test: (node) => {\n const allowedBlocks = ["core/paragraph", "core/heading", "core/image"];\n\n // if this isn\'t an allowed block catch it\n // if this is an allowed block it should have been handled at this ppint\n if (\n node.type !== "text" &&\n !allowedBlocks.some((blockName) => isBlockByName(node, blockName))\n ) {\n return true;\n }\n\n return (\n node.type === "text" &&\n (node.parent === null || node.data?.trim().length === 0)\n );\n },\n};\n')),(0,o.kt)("p",null,"The goal of the EmptyBlock is to catch all non-allowed blocks and skip rendering them at all. Additionally, it also catches orphan text nodes that only contain whitespaces (this would catch things carriage returns, spacing around tags, etc\u2026)"),(0,o.kt)("p",null,"Note that we\u2019re using defaultProps to provide the test function. This has the same result of passing the test function as a prop directly."),(0,o.kt)("p",null,"The next step is implementing a RawText component."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'/**\n * Trims raw text nodes\n *\n * @param {*} param0\n * @returns\n */\nconst RawText = ({ domNode }) => {\n return domNode.data.trim();\n};\n\nRawText.defaultProps = {\n /**\n * Catches any non-orphans and non-empty text fields\n *\n * @param {*} node\n * @returns\n */\n test: (node) =>\n node.type === "text" &&\n node.parent !== null &&\n node.data?.trim().length >= 0,\n};\n')),(0,o.kt)("p",null,'The goal here is to trim all text nodes. This is mostly to clean up text nodes. Therefore, we catch any non-orphans and non-empty text field nodes and replace them with a "trimmed" version.'),(0,o.kt)("p",null,"Now we have ensured that we don\u2019t have lingering text nodes and that valid text node does not contain additional whitespaces at the beginning and end."),(0,o.kt)("h2",{id:"paragraph-block"},"Paragraph Block"),(0,o.kt)("p",null,"Implementing the Paragraph block is pretty simple. All we need to do is use the React Native Text component"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'import { /* ... */, Text} from "react-native";\n\nconst RNParagraphBlock = ({ children }) => {\n return {children};\n};\n')),(0,o.kt)("p",null,'Note that this is essentially replacing the "p" tag with a native "Text" component. "children" in this context represent text nodes that are processed via the "RawText" block. If we didn\u2019t render children here, RawText block would never be executed for this paragraph. It\u2019s recursive logic!'),(0,o.kt)("h2",{id:"heading-block"},"Heading Block"),(0,o.kt)("p",null,'The heading block is very similar, we leverage the "level" prop that\u2019s automatically passed by the HeadingBlock component. We use it to create a dynamic class name that contains the style for the heading.'),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'import { /* ... */, Text} from "react-native";\n\nconst RNHeadingBlock = ({ children, level }) => {\n return {children};\n};\n\nconst styles = StyleSheet.create({\n container: {\n flex: 1,\n backgroundColor: "#fff",\n alignItems: "center",\n justifyContent: "center",\n },\n headingLevel1: {\n fontWeight: "bold",\n fontSize: "26px",\n },\n headingLevel2: {\n fontWeight: "bold",\n fontSize: "20px",\n },\n});\n')),(0,o.kt)("h2",{id:"image-block"},"Image Block"),(0,o.kt)("p",null,'The last block we\u2019ll implement is the image block. It is a bit more complex but it first captures the image caption by looping through the DOM node children until it finds a "figcaption" Then it uses the "height", "width" and "src" props that are automatically passed by the ImageBlock component to render the image using the native "Image" component.'),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-js"},'import { /* ... */, Image, Text} from "react-native";\n\nconst RNImageBlock = ({ domNode, height, width, src }) => {\n const caption =\n domNode.children.find((el) => el.name === "figcaption")?.firstChild?.data ??\n "";\n return (\n <>\n \n {caption}\n \n );\n};\n')),(0,o.kt)("h2",{id:"result"},"Result"),(0,o.kt)("p",null,"The demo app should render something like this"),(0,o.kt)("p",null,(0,o.kt)("img",{alt:"Blocks App",src:n(1264).Z,width:"495",height:"1024"})))}p.isMDXComponent=!0},1264:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/blocks-app-8e0dc4891e16eece268a8dd31d9b9564.png"}}]); \ No newline at end of file diff --git a/assets/js/d0ce585b.a4d499ee.js b/assets/js/d0ce585b.e796b7c6.js similarity index 87% rename from assets/js/d0ce585b.a4d499ee.js rename to assets/js/d0ce585b.e796b7c6.js index 17f211297..cbd5bcfd3 100644 --- a/assets/js/d0ce585b.a4d499ee.js +++ b/assets/js/d0ce585b.e796b7c6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6255],{3905:(e,t,r)=>{r.d(t,{Zo:()=>o,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function p(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var c=a.createContext({}),l=function(e){var t=a.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):p(p({},t),e)),r},o=function(e){var t=l(e.components);return a.createElement(c.Provider,{value:t},e.children)},s="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},f=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,c=e.parentName,o=d(e,["components","mdxType","originalType","parentName"]),s=l(r),f=n,m=s["".concat(c,".").concat(f)]||s[f]||h[f]||i;return r?a.createElement(m,p(p({ref:t},o),{},{components:r})):a.createElement(m,p({ref:t},o))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,p=new Array(i);p[0]=f;var d={};for(var c in t)hasOwnProperty.call(t,c)&&(d[c]=t[c]);d.originalType=e,d[s]="string"==typeof e?e:n,p[1]=d;for(var l=2;l{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>p,default:()=>s,frontMatter:()=>i,metadata:()=>d,toc:()=>l});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.TermSearchEntity",title:"Interface: TermSearchEntity",sidebar_label:"@headstartwp/core.TermSearchEntity",custom_edit_url:null},p=void 0,d={unversionedId:"interfaces/headstartwp_core.TermSearchEntity",id:"interfaces/headstartwp_core.TermSearchEntity",title:"Interface: TermSearchEntity",description:"@headstartwp/core.TermSearchEntity",source:"@site/docs/interfaces/headstartwp_core.TermSearchEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.TermSearchEntity",permalink:"/docs/api/interfaces/headstartwp_core.TermSearchEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.TermSearchEntity",title:"Interface: TermSearchEntity",sidebar_label:"@headstartwp/core.TermSearchEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.TermEntity",permalink:"/docs/api/interfaces/headstartwp_core.TermEntity"},next:{title:"@headstartwp/core.TypeEntity",permalink:"/docs/api/interfaces/headstartwp_core.TypeEntity"}},c={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embedded",id:"_embedded",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"type",id:"type",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"url",id:"url",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4}],o={toc:l};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},o,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".TermSearchEntity"),(0,n.kt)("p",null,"Interface for terms entities from the /wp/v2/search endpoint."),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"SearchObjectEntity"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"TermSearchEntity"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"_embedded"},"_","embedded"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"_","embedded"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"self")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]")))),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L700"},"packages/core/src/data/types/entities.ts:700")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"id"},"id"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"id"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"Unique identifier for the object."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},"SearchObjectEntity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity#id"},"id")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L658"},"packages/core/src/data/types/entities.ts:658")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"title"},"title"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"title"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The title for the object."),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},"SearchObjectEntity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity#title"},"title")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L668"},"packages/core/src/data/types/entities.ts:668")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"type"},"type"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"type"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"post"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"term"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"post-format"')),(0,n.kt)("p",null,"Type of Search for the object."),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},"SearchObjectEntity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity#type"},"type")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L673"},"packages/core/src/data/types/entities.ts:673")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"url"},"url"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"url"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"URL to the object."),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},"SearchObjectEntity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity#url"},"url")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L663"},"packages/core/src/data/types/entities.ts:663")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},"SearchObjectEntity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity#yoast_head"},"yoast_head")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},"SearchObjectEntity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity#yoast_head_json"},"yoast_head_json")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6255],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function p(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var l=a.createContext({}),o=function(e){var t=a.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):p(p({},t),e)),r},c=function(e){var t=o(e.components);return a.createElement(l.Provider,{value:t},e.children)},s="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},f=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,l=e.parentName,c=d(e,["components","mdxType","originalType","parentName"]),s=o(r),f=n,m=s["".concat(l,".").concat(f)]||s[f]||h[f]||i;return r?a.createElement(m,p(p({ref:t},c),{},{components:r})):a.createElement(m,p({ref:t},c))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,p=new Array(i);p[0]=f;var d={};for(var l in t)hasOwnProperty.call(t,l)&&(d[l]=t[l]);d.originalType=e,d[s]="string"==typeof e?e:n,p[1]=d;for(var o=2;o{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>s,frontMatter:()=>i,metadata:()=>d,toc:()=>o});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.TermSearchEntity",title:"Interface: TermSearchEntity",sidebar_label:"@headstartwp/core.TermSearchEntity",custom_edit_url:null},p=void 0,d={unversionedId:"interfaces/headstartwp_core.TermSearchEntity",id:"interfaces/headstartwp_core.TermSearchEntity",title:"Interface: TermSearchEntity",description:"@headstartwp/core.TermSearchEntity",source:"@site/docs/interfaces/headstartwp_core.TermSearchEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.TermSearchEntity",permalink:"/docs/api/interfaces/headstartwp_core.TermSearchEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.TermSearchEntity",title:"Interface: TermSearchEntity",sidebar_label:"@headstartwp/core.TermSearchEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.TermEntity",permalink:"/docs/api/interfaces/headstartwp_core.TermEntity"},next:{title:"@headstartwp/core.TypeEntity",permalink:"/docs/api/interfaces/headstartwp_core.TypeEntity"}},l={},o=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"_embedded",id:"_embedded",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"id",id:"id",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"title",id:"title",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"type",id:"type",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"url",id:"url",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4}],c={toc:o};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".TermSearchEntity"),(0,n.kt)("p",null,"Interface for terms entities from the /wp/v2/search endpoint."),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"SearchObjectEntity"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"TermSearchEntity"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"_embedded"},"_","embedded"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"_","embedded"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"self")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"TermEntity")),"[]")))),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L700"},"packages/core/src/data/types/entities.ts:700")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"id"},"id"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"id"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"number")),(0,n.kt)("p",null,"Unique identifier for the object."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},"SearchObjectEntity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity#id"},"id")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L658"},"packages/core/src/data/types/entities.ts:658")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"title"},"title"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"title"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The title for the object."),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},"SearchObjectEntity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity#title"},"title")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L668"},"packages/core/src/data/types/entities.ts:668")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"type"},"type"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"type"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"post"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"term"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"post-format"')),(0,n.kt)("p",null,"Type of Search for the object."),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},"SearchObjectEntity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity#type"},"type")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L673"},"packages/core/src/data/types/entities.ts:673")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"url"},"url"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"url"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"URL to the object."),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},"SearchObjectEntity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity#url"},"url")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L663"},"packages/core/src/data/types/entities.ts:663")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},"SearchObjectEntity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity#yoast_head"},"yoast_head")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},"SearchObjectEntity"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity#yoast_head_json"},"yoast_head_json")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d19e169a.c07cd7fd.js b/assets/js/d19e169a.1b772d6e.js similarity index 97% rename from assets/js/d19e169a.c07cd7fd.js rename to assets/js/d19e169a.1b772d6e.js index 756952a67..3ee1a2ba6 100644 --- a/assets/js/d19e169a.c07cd7fd.js +++ b/assets/js/d19e169a.1b772d6e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4504],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var c=n.createContext({}),l=function(e){var t=n.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},d=function(e){var t=l(e.components);return n.createElement(c.Provider,{value:t},e.children)},u="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,c=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),u=l(r),m=a,h=u["".concat(c,".").concat(m)]||u[m]||p[m]||o;return r?n.createElement(h,i(i({ref:t},d),{},{components:r})):n.createElement(h,i({ref:t},d))}));function h(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=m;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s[u]="string"==typeof e?e:a,i[1]=s;for(var l=2;l{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>l});var n=r(7462),a=(r(7294),r(3905));const o={slug:"/wordpress-integration/basic-auth"},i="Basic Auth",s={unversionedId:"WordPress Integration/basic-auth",id:"WordPress Integration/basic-auth",title:"Basic Auth",description:"If WordPress is protected by Basic Auth (which is common during development) you can tell HeadstartWP the basic auth creds so that all",source:"@site/documentation/06-WordPress Integration/basic-auth.md",sourceDirName:"06-WordPress Integration",slug:"/wordpress-integration/basic-auth",permalink:"/docs/learn/wordpress-integration/basic-auth",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/06-WordPress Integration/basic-auth.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",frontMatter:{slug:"/wordpress-integration/basic-auth"},sidebar:"tutorialSidebar",previous:{title:"On-demand ISR revalidation",permalink:"/docs/learn/wordpress-integration/revalidate"},next:{title:"Feeds",permalink:"/docs/learn/wordpress-integration/feeds"}},c={},l=[],d={toc:l};function u(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"basic-auth"},"Basic Auth"),(0,a.kt)("p",null,"If WordPress is protected by Basic Auth (which is common during development) you can tell HeadstartWP the basic auth creds so that all\nREST API requests include them. To do so, simply add the following env variables:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"WP_BASIC_AUTH_USERNAME=username\nWP_BASIC_AUTH_PASSWORD=password\n")),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"The above env variables will only be accessible server-side and therefore any client-side requests made directly to WordPress will fail. This happens because Next.js only includes env variables prefixed with ",(0,a.kt)("inlineCode",{parentName:"p"},"NEXT_PUBLIC_")," in the browser bundle."),(0,a.kt)("p",{parentName:"admonition"},"If you want your client-side requests to work, prefix the above variables with ",(0,a.kt)("inlineCode",{parentName:"p"},"NEXT_PUBLIC_"),". But note that the basic auth creds will be leaked to the public.")))}u.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[4504],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var c=n.createContext({}),l=function(e){var t=n.useContext(c),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},d=function(e){var t=l(e.components);return n.createElement(c.Provider,{value:t},e.children)},u="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,c=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),u=l(r),m=a,h=u["".concat(c,".").concat(m)]||u[m]||p[m]||o;return r?n.createElement(h,i(i({ref:t},d),{},{components:r})):n.createElement(h,i({ref:t},d))}));function h(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=m;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s[u]="string"==typeof e?e:a,i[1]=s;for(var l=2;l{r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>l});var n=r(7462),a=(r(7294),r(3905));const o={slug:"/wordpress-integration/basic-auth"},i="Basic Auth",s={unversionedId:"WordPress Integration/basic-auth",id:"WordPress Integration/basic-auth",title:"Basic Auth",description:"If WordPress is protected by Basic Auth (which is common during development) you can tell HeadstartWP the basic auth creds so that all",source:"@site/documentation/06-WordPress Integration/basic-auth.md",sourceDirName:"06-WordPress Integration",slug:"/wordpress-integration/basic-auth",permalink:"/docs/learn/wordpress-integration/basic-auth",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/06-WordPress Integration/basic-auth.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",frontMatter:{slug:"/wordpress-integration/basic-auth"},sidebar:"tutorialSidebar",previous:{title:"On-demand ISR revalidation",permalink:"/docs/learn/wordpress-integration/revalidate"},next:{title:"Feeds",permalink:"/docs/learn/wordpress-integration/feeds"}},c={},l=[],d={toc:l};function u(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"basic-auth"},"Basic Auth"),(0,a.kt)("p",null,"If WordPress is protected by Basic Auth (which is common during development) you can tell HeadstartWP the basic auth creds so that all\nREST API requests include them. To do so, simply add the following env variables:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"WP_BASIC_AUTH_USERNAME=username\nWP_BASIC_AUTH_PASSWORD=password\n")),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"The above env variables will only be accessible server-side and therefore any client-side requests made directly to WordPress will fail. This happens because Next.js only includes env variables prefixed with ",(0,a.kt)("inlineCode",{parentName:"p"},"NEXT_PUBLIC_")," in the browser bundle."),(0,a.kt)("p",{parentName:"admonition"},"If you want your client-side requests to work, prefix the above variables with ",(0,a.kt)("inlineCode",{parentName:"p"},"NEXT_PUBLIC_"),". But note that the basic auth creds will be leaked to the public.")))}u.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d847ebfc.5dc0f790.js b/assets/js/d847ebfc.b9f56084.js similarity index 99% rename from assets/js/d847ebfc.5dc0f790.js rename to assets/js/d847ebfc.b9f56084.js index 7fabe40b2..a020e4d3c 100644 --- a/assets/js/d847ebfc.5dc0f790.js +++ b/assets/js/d847ebfc.b9f56084.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[521],{3905:(e,t,n)=>{n.d(t,{Zo:()=>l,kt:()=>f});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var c=a.createContext({}),p=function(e){var t=a.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},l=function(e){var t=p(e.components);return a.createElement(c.Provider,{value:t},e.children)},d="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,c=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),d=p(n),u=r,f=d["".concat(c,".").concat(u)]||d[u]||h[u]||o;return n?a.createElement(f,i(i({ref:t},l),{},{components:n})):a.createElement(f,i({ref:t},l))}));function f(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,i=new Array(o);i[0]=u;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s[d]="string"==typeof e?e:r,i[1]=s;for(var p=2;p{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>p});var a=n(7462),r=(n(7294),n(3905));const o={slug:"/data-fetching/prefetching"},i="Prefetching data on the server",s={unversionedId:"Data Fetching/prefetching-data-server",id:"Data Fetching/prefetching-data-server",title:"Prefetching data on the server",description:"To enable prefetching data on the server use the fetchHookData function alongside addHookData.",source:"@site/documentation/02 - Data Fetching/prefetching-data-server.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/prefetching",permalink:"/docs/learn/data-fetching/prefetching",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/prefetching-data-server.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",frontMatter:{slug:"/data-fetching/prefetching"},sidebar:"tutorialSidebar",previous:{title:"Creating your own custom hooks",permalink:"/docs/learn/data-fetching/creating-your-own-custom-hooks"},next:{title:"Escaping & Sanitization",permalink:"/docs/learn/utilities/sanitization"}},c={},p=[],l={toc:p};function d(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},l,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"prefetching-data-on-the-server"},"Prefetching data on the server"),(0,r.kt)("p",null,"To enable prefetching data on the server use the ",(0,r.kt)("inlineCode",{parentName:"p"},"fetchHookData")," function alongside ",(0,r.kt)("inlineCode",{parentName:"p"},"addHookData"),".\nWe also recommend using the ",(0,r.kt)("inlineCode",{parentName:"p"},"handleError")," function and to wrap the ",(0,r.kt)("inlineCode",{parentName:"p"},"fetchHookData")," call in a try/catch."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/[...path].js"',title:'"src/pages/[...path].js"'},"import { \n usePost, \n fetchHookData, \n addHookData, \n handleError\n} from '@headstartwp/next';\n\nconst params = { postType: ['post', 'page'] };\n\nconst SinglePostsPage = () => {\n const { data } = usePost(params);\n\n // when doing ssr/ssg data will always be available so handling loading/error state is optional\n\n return (\n
\n

{data?.post.title.rendered}

\n
\n );\n};\n\nexport default SinglePostsPage;\n\n// or export async function getServerSideProps(context)\nexport async function getStaticProps(context) {\n try {\n const usePostHook = await fetchHookData(usePost.fetcher(), context, { params });\n\n return addHookData([usePostHook], { myCustomProp: 'value' });\n } catch (e) {\n return handleError(e, context);\n }\n}\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"The ",(0,r.kt)("a",{parentName:"li",href:"/api/modules/headstartwp_next#fetchhookdata"},"fetchHookData")," function receives a ",(0,r.kt)("a",{parentName:"li",href:"/api/classes/headstartwp_core.AbstractFetchStrategy/"},"strategy"),", the Next.js context object and an object containing the params. The ",(0,r.kt)("inlineCode",{parentName:"li"},"params")," must match the params passed to the hook, hence why it's been moved into a variable outside of the ",(0,r.kt)("inlineCode",{parentName:"li"},"SinglePostsPage")," component."),(0,r.kt)("li",{parentName:"ul"},"The ",(0,r.kt)("a",{parentName:"li",href:"/api/modules/headstartwp_next#addhookdata"},"addHookData")," receives an array of responses returned by ",(0,r.kt)("inlineCode",{parentName:"li"},"fetchHookData")," and prepares that data to be returned to the page as props. If you need to pass additional props just pass them in the second argument."),(0,r.kt)("li",{parentName:"ul"},"The ",(0,r.kt)("a",{parentName:"li",href:"/api/modules/headstartwp_next#ahandleError"},"handleError")," function handles errors such as 404, redirects (when redirects are set to 404) among other things.")),(0,r.kt)("p",null,"We recommend reviewing the ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/tree/develop/projects/wp-nextjs"},"starter project")," for more examples of prefetching data on the server."))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[521],{3905:(e,t,n)=>{n.d(t,{Zo:()=>l,kt:()=>f});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var c=a.createContext({}),p=function(e){var t=a.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},l=function(e){var t=p(e.components);return a.createElement(c.Provider,{value:t},e.children)},d="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,c=e.parentName,l=s(e,["components","mdxType","originalType","parentName"]),d=p(n),u=r,f=d["".concat(c,".").concat(u)]||d[u]||h[u]||o;return n?a.createElement(f,i(i({ref:t},l),{},{components:n})):a.createElement(f,i({ref:t},l))}));function f(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,i=new Array(o);i[0]=u;var s={};for(var c in t)hasOwnProperty.call(t,c)&&(s[c]=t[c]);s.originalType=e,s[d]="string"==typeof e?e:r,i[1]=s;for(var p=2;p{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>p});var a=n(7462),r=(n(7294),n(3905));const o={slug:"/data-fetching/prefetching"},i="Prefetching data on the server",s={unversionedId:"Data Fetching/prefetching-data-server",id:"Data Fetching/prefetching-data-server",title:"Prefetching data on the server",description:"To enable prefetching data on the server use the fetchHookData function alongside addHookData.",source:"@site/documentation/02 - Data Fetching/prefetching-data-server.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/prefetching",permalink:"/docs/learn/data-fetching/prefetching",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/prefetching-data-server.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",frontMatter:{slug:"/data-fetching/prefetching"},sidebar:"tutorialSidebar",previous:{title:"Creating your own custom hooks",permalink:"/docs/learn/data-fetching/creating-your-own-custom-hooks"},next:{title:"Escaping & Sanitization",permalink:"/docs/learn/utilities/sanitization"}},c={},p=[],l={toc:p};function d(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},l,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"prefetching-data-on-the-server"},"Prefetching data on the server"),(0,r.kt)("p",null,"To enable prefetching data on the server use the ",(0,r.kt)("inlineCode",{parentName:"p"},"fetchHookData")," function alongside ",(0,r.kt)("inlineCode",{parentName:"p"},"addHookData"),".\nWe also recommend using the ",(0,r.kt)("inlineCode",{parentName:"p"},"handleError")," function and to wrap the ",(0,r.kt)("inlineCode",{parentName:"p"},"fetchHookData")," call in a try/catch."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/[...path].js"',title:'"src/pages/[...path].js"'},"import { \n usePost, \n fetchHookData, \n addHookData, \n handleError\n} from '@headstartwp/next';\n\nconst params = { postType: ['post', 'page'] };\n\nconst SinglePostsPage = () => {\n const { data } = usePost(params);\n\n // when doing ssr/ssg data will always be available so handling loading/error state is optional\n\n return (\n
\n

{data?.post.title.rendered}

\n
\n );\n};\n\nexport default SinglePostsPage;\n\n// or export async function getServerSideProps(context)\nexport async function getStaticProps(context) {\n try {\n const usePostHook = await fetchHookData(usePost.fetcher(), context, { params });\n\n return addHookData([usePostHook], { myCustomProp: 'value' });\n } catch (e) {\n return handleError(e, context);\n }\n}\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"The ",(0,r.kt)("a",{parentName:"li",href:"/api/modules/headstartwp_next#fetchhookdata"},"fetchHookData")," function receives a ",(0,r.kt)("a",{parentName:"li",href:"/api/classes/headstartwp_core.AbstractFetchStrategy/"},"strategy"),", the Next.js context object and an object containing the params. The ",(0,r.kt)("inlineCode",{parentName:"li"},"params")," must match the params passed to the hook, hence why it's been moved into a variable outside of the ",(0,r.kt)("inlineCode",{parentName:"li"},"SinglePostsPage")," component."),(0,r.kt)("li",{parentName:"ul"},"The ",(0,r.kt)("a",{parentName:"li",href:"/api/modules/headstartwp_next#addhookdata"},"addHookData")," receives an array of responses returned by ",(0,r.kt)("inlineCode",{parentName:"li"},"fetchHookData")," and prepares that data to be returned to the page as props. If you need to pass additional props just pass them in the second argument."),(0,r.kt)("li",{parentName:"ul"},"The ",(0,r.kt)("a",{parentName:"li",href:"/api/modules/headstartwp_next#ahandleError"},"handleError")," function handles errors such as 404, redirects (when redirects are set to 404) among other things.")),(0,r.kt)("p",null,"We recommend reviewing the ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/tree/develop/projects/wp-nextjs"},"starter project")," for more examples of prefetching data on the server."))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d87415d1.d6135791.js b/assets/js/d87415d1.b3177477.js similarity index 99% rename from assets/js/d87415d1.d6135791.js rename to assets/js/d87415d1.b3177477.js index 0a63f41f0..bab43e7f3 100644 --- a/assets/js/d87415d1.d6135791.js +++ b/assets/js/d87415d1.b3177477.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5148],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>m});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function s(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),p=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},u=function(e){var t=p(e.components);return r.createElement(l.Provider,{value:t},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,u=o(e,["components","mdxType","originalType","parentName"]),d=p(n),h=a,m=d["".concat(l,".").concat(h)]||d[h]||c[h]||i;return n?r.createElement(m,s(s({ref:t},u),{},{components:n})):r.createElement(m,s({ref:t},u))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,s=new Array(i);s[0]=h;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o[d]="string"==typeof e?e:a,s[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var r=n(7462),a=(n(7294),n(3905));const i={sidebar_position:1,slug:"/wordpress-integration/multisite"},s="Multisite",o={unversionedId:"WordPress Integration/multisite",id:"WordPress Integration/multisite",title:"Multisite",description:"HeadstartWP has built-in support for WordPress multisite via the sites property in the headstartwp.config.js file. This transforms the Next.js app into a multi-tenant app.",source:"@site/documentation/06-WordPress Integration/multisite.md",sourceDirName:"06-WordPress Integration",slug:"/wordpress-integration/multisite",permalink:"/docs/learn/wordpress-integration/multisite",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/06-WordPress Integration/multisite.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",sidebarPosition:1,frontMatter:{sidebar_position:1,slug:"/wordpress-integration/multisite"},sidebar:"tutorialSidebar",previous:{title:"Previews",permalink:"/docs/learn/wordpress-integration/previews"},next:{title:"On-demand ISR revalidation",permalink:"/docs/learn/wordpress-integration/revalidate"}},l={},p=[{value:"Usage",id:"usage",level:2},{value:"Config",id:"config",level:3},{value:"Internationalized routing",id:"internationalized-routing",level:4},{value:"Middleware",id:"middleware",level:3},{value:"Folder structure",id:"folder-structure",level:3},{value:"Creating Routes that target a specific site",id:"creating-routes-that-target-a-specific-site",level:3},{value:"Known Issues",id:"known-issues",level:2}],u={toc:p};function d(e){let{components:t,...i}=e;return(0,a.kt)("wrapper",(0,r.Z)({},u,i,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"multisite"},"Multisite"),(0,a.kt)("p",null,"HeadstartWP has built-in support for WordPress multisite via the ",(0,a.kt)("inlineCode",{parentName:"p"},"sites")," property in the ",(0,a.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," file. This transforms the Next.js app into a multi-tenant app."),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"sites")," option allows specifying as many sites you want to connect to your app. Each site must have a ",(0,a.kt)("inlineCode",{parentName:"p"},"sourceUrl")," and a ",(0,a.kt)("inlineCode",{parentName:"p"},"hostUrl"),". The ",(0,a.kt)("inlineCode",{parentName:"p"},"hostUrl")," will be used to match the current site and ",(0,a.kt)("inlineCode",{parentName:"p"},"sourceUrl")," indicates where content should be sourced from."),(0,a.kt)("p",null,"This feature does not require that all sites belong to the same multisite, you're free to connect the Next.js app to a completely separate WordPress instance, as long as that instance implements what your Next.js app needs."),(0,a.kt)("p",null,"Take a look at the ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/tree/develop/projects/wp-multisite-nextjs"},"multisite demo project")," to familiarize yourself with the set-up."),(0,a.kt)("h2",{id:"usage"},"Usage"),(0,a.kt)("h3",{id:"config"},"Config"),(0,a.kt)("p",null,"The first step is to declare all of your sites in ",(0,a.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js"),". In the example below we're declaring two sites."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"/**\n * Headless Config\n *\n * @type {import('@headstartwp/core').HeadlessConfig}\n */\nmodule.exports = {\n redirectStrategy: '404',\n useWordPressPlugin: true,\n\n sites: [\n {\n hostUrl: 'http://site1.localhost:3001',\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,\n\n },\n {\n hostUrl: 'http://site2.localhost:3001',\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL_2,\n },\n ],\n};\n")),(0,a.kt)("p",null,"In the example above we specify that all sites must use the WordPress plugin and that the redirect strategy should be ",(0,a.kt)("inlineCode",{parentName:"p"},"404"),". Then we're declaring two sites that will respond via the ",(0,a.kt)("a",{parentName:"p",href:"http://site1.localhost:3001"},"http://site1.localhost:3001")," and ",(0,a.kt)("a",{parentName:"p",href:"http://site2.localhost:3001"},"http://site2.localhost:3001")," URLs. The ",(0,a.kt)("inlineCode",{parentName:"p"},"sourceUrl")," for each comes from an env variable."),(0,a.kt)("p",null,"This means that when we visit ",(0,a.kt)("a",{parentName:"p",href:"http://site1.localhost:3001"},"http://site1.localhost:3001"),", the source URL specified by ",(0,a.kt)("inlineCode",{parentName:"p"},"NEXT_PUBLIC_HEADLESS_WP_URL")," will be used."),(0,a.kt)("h4",{id:"internationalized-routing"},"Internationalized routing"),(0,a.kt)("p",null,"If you're using ",(0,a.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/advanced-features/i18n-routing"},"Next.js i18n")," feature you can specify the locale in the site's config object and the locale will also be used when matching a site."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"/**\n * Headless Config\n *\n * @type {import('@headstartwp/core').HeadlessConfig}\n */\nmodule.exports = {\n redirectStrategy: '404',\n useWordPressPlugin: true,\n\n sites: [\n {\n hostUrl: 'http://site1.localhost:3001',\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,\n locale: 'en'\n },\n {\n hostUrl: 'http://site1.localhost:3001',\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL_2,\n locale: 'es'\n },\n ],\n};\n")),(0,a.kt)("p",null,"The above config means that ",(0,a.kt)("inlineCode",{parentName:"p"},"http://site1.localhost:3001/en")," will match the first site config and ",(0,a.kt)("inlineCode",{parentName:"p"},"http://site1.localhost:3001/es")," will match the second site config."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"Note"),": You must declare those locales in Next.js config. See ",(0,a.kt)("a",{parentName:"p",href:"https://nextjs.org/learn/advanced-features/i18n-routing"},"Next.js documentation")," for more information."),(0,a.kt)("p",null,"When using locales make sure to add the locale to ",(0,a.kt)("inlineCode",{parentName:"p"},"Settings -> General -> Headless Multisite Locale (optional)"),". This is required for previews and the revalidate handler to work properly since API routes are not localized in Next.js."),(0,a.kt)("p",null,"As an example, the first site config in the example above would need the following settings in WordPress."),(0,a.kt)("p",null,(0,a.kt)("img",{alt:"Plugin settings Multisite Locale",src:n(6078).Z,width:"759",height:"349"})),(0,a.kt)("h3",{id:"middleware"},"Middleware"),(0,a.kt)("p",null,"Make sure you have the framework's middleware setup at ",(0,a.kt)("inlineCode",{parentName:"p"},"src/middleware.js"),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"import { AppMiddleware } from '@headstartwp/next/middlewares';\n\nexport const config = {\n matcher: [\n /*\n * Match all paths except for:\n * 1. /api routes\n * 2. /_next (Next.js internals)\n * 3. /fonts (inside /public)\n * 4. all root files inside /public (e.g. /favicon.ico)\n */\n '/((?!api|_next|fonts[\\\\w-]+\\\\.\\\\w+).*)',\n ],\n};\n\nexport async function middleware(...args) {\n return AppMiddleware(...args);\n}\n")),(0,a.kt)("h3",{id:"folder-structure"},"Folder structure"),(0,a.kt)("p",null,"Put all of your page routes in ",(0,a.kt)("inlineCode",{parentName:"p"},"_sites/[site]/")," folder with the exception of the following files"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"_app.js"),(0,a.kt)("li",{parentName:"ul"},"_document.js"),(0,a.kt)("li",{parentName:"ul"},"404.js"),(0,a.kt)("li",{parentName:"ul"},"500.js"),(0,a.kt)("li",{parentName:"ul"},"api/")),(0,a.kt)("p",null," This should give you a structure similar to"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"_sites/\n\u251c\u2500 [site]/\n\u2502 \u251c\u2500 [...path].js\n\u2502 \u251c\u2500 index.js\n_app.js\n_document.js\n404.js\n500.js\napi/\n")),(0,a.kt)("p",null,"With this setup, the framework's middleware will rewrite all requests to ",(0,a.kt)("inlineCode",{parentName:"p"},"_sites/hostName"),". All of the data-fetching hooks will fetch data to the appropriate WordPress instance."),(0,a.kt)("p",null,"This allows you to power all of your sites with the same codebase. This is very useful if you're building sites that support internationalization or if the only thing that changes across sites is the content."),(0,a.kt)("h3",{id:"creating-routes-that-target-a-specific-site"},"Creating Routes that target a specific site"),(0,a.kt)("p",null,"It is possible to create routes specific to each site. To do this simply create a folder for that particular site eg: ",(0,a.kt)("inlineCode",{parentName:"p"},"src/pages/_sites/mysite.com/index.js"),". Then when a user visits ",(0,a.kt)("inlineCode",{parentName:"p"},"mysite.com")," the ",(0,a.kt)("inlineCode",{parentName:"p"},"index.js")," route file will be used instead of the one in ",(0,a.kt)("inlineCode",{parentName:"p"},"[site]/index.js"),"."),(0,a.kt)("p",null,"This provides a powerful way of powering complex multi-tenant apps that shares a codebase but render completely different pages and layouts."),(0,a.kt)("h2",{id:"known-issues"},"Known Issues"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"404.js and 500.js are unable to know the current site")),(0,a.kt)("p",null,"At the moment, there's a limitation in Next.js that doesn't allow the ",(0,a.kt)("inlineCode",{parentName:"p"},"404.js")," and ",(0,a.kt)("inlineCode",{parentName:"p"},"500.js")," pages to know the current site. These two files ",(0,a.kt)("strong",{parentName:"p"},"must")," be in the root of the pages directory and we can't rewrite them. Additionally, they only support ",(0,a.kt)("inlineCode",{parentName:"p"},"getStaticProps")," which means there's no way to know which site you're on in case you need to fetch data specific for that site."),(0,a.kt)("p",null,"If you need to fetch data in ",(0,a.kt)("inlineCode",{parentName:"p"},"404.js")," or ",(0,a.kt)("inlineCode",{parentName:"p"},"500.js")," there's one workaround but it relies on client-side data-fetching. In ",(0,a.kt)("inlineCode",{parentName:"p"},"_app.js")," do the following:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"import { getSiteByHost } from '@headstartwp/core';\n\n//grab the current site\nconst currentSite = useMemo(() => {\n if (router.query?.site && !Array.isArray(router.query.site)) {\n return getSiteByHost(router.query.site, router.locale);\n }\n\n // 404.js and 500.js do not have a site query param.\n if (typeof window !== 'undefined') {\n return getSiteByHost(window.location.host, router.locale);\n }\n return {};\n}, [router]);\n\n// pass it to HeadlessApp to override the current site settings defined by the framework\n// once react hydrates and window is defined, the currentSite will be set for 404 and 500 poages.\n\n")))}d.isMDXComponent=!0},6078:(e,t,n)=>{n.d(t,{Z:()=>r});const r=n.p+"assets/images/multisite-locale-60d679b73933b2e528aac602efd6e3d6.png"}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5148],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>m});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function s(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),p=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},u=function(e){var t=p(e.components);return r.createElement(l.Provider,{value:t},e.children)},d="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,u=o(e,["components","mdxType","originalType","parentName"]),d=p(n),h=a,m=d["".concat(l,".").concat(h)]||d[h]||c[h]||i;return n?r.createElement(m,s(s({ref:t},u),{},{components:n})):r.createElement(m,s({ref:t},u))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,s=new Array(i);s[0]=h;var o={};for(var l in t)hasOwnProperty.call(t,l)&&(o[l]=t[l]);o.originalType=e,o[d]="string"==typeof e?e:a,s[1]=o;for(var p=2;p{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var r=n(7462),a=(n(7294),n(3905));const i={sidebar_position:1,slug:"/wordpress-integration/multisite"},s="Multisite",o={unversionedId:"WordPress Integration/multisite",id:"WordPress Integration/multisite",title:"Multisite",description:"HeadstartWP has built-in support for WordPress multisite via the sites property in the headstartwp.config.js file. This transforms the Next.js app into a multi-tenant app.",source:"@site/documentation/06-WordPress Integration/multisite.md",sourceDirName:"06-WordPress Integration",slug:"/wordpress-integration/multisite",permalink:"/docs/learn/wordpress-integration/multisite",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/06-WordPress Integration/multisite.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",sidebarPosition:1,frontMatter:{sidebar_position:1,slug:"/wordpress-integration/multisite"},sidebar:"tutorialSidebar",previous:{title:"Previews",permalink:"/docs/learn/wordpress-integration/previews"},next:{title:"On-demand ISR revalidation",permalink:"/docs/learn/wordpress-integration/revalidate"}},l={},p=[{value:"Usage",id:"usage",level:2},{value:"Config",id:"config",level:3},{value:"Internationalized routing",id:"internationalized-routing",level:4},{value:"Middleware",id:"middleware",level:3},{value:"Folder structure",id:"folder-structure",level:3},{value:"Creating Routes that target a specific site",id:"creating-routes-that-target-a-specific-site",level:3},{value:"Known Issues",id:"known-issues",level:2}],u={toc:p};function d(e){let{components:t,...i}=e;return(0,a.kt)("wrapper",(0,r.Z)({},u,i,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"multisite"},"Multisite"),(0,a.kt)("p",null,"HeadstartWP has built-in support for WordPress multisite via the ",(0,a.kt)("inlineCode",{parentName:"p"},"sites")," property in the ",(0,a.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," file. This transforms the Next.js app into a multi-tenant app."),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"sites")," option allows specifying as many sites you want to connect to your app. Each site must have a ",(0,a.kt)("inlineCode",{parentName:"p"},"sourceUrl")," and a ",(0,a.kt)("inlineCode",{parentName:"p"},"hostUrl"),". The ",(0,a.kt)("inlineCode",{parentName:"p"},"hostUrl")," will be used to match the current site and ",(0,a.kt)("inlineCode",{parentName:"p"},"sourceUrl")," indicates where content should be sourced from."),(0,a.kt)("p",null,"This feature does not require that all sites belong to the same multisite, you're free to connect the Next.js app to a completely separate WordPress instance, as long as that instance implements what your Next.js app needs."),(0,a.kt)("p",null,"Take a look at the ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/tree/develop/projects/wp-multisite-nextjs"},"multisite demo project")," to familiarize yourself with the set-up."),(0,a.kt)("h2",{id:"usage"},"Usage"),(0,a.kt)("h3",{id:"config"},"Config"),(0,a.kt)("p",null,"The first step is to declare all of your sites in ",(0,a.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js"),". In the example below we're declaring two sites."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"/**\n * Headless Config\n *\n * @type {import('@headstartwp/core').HeadlessConfig}\n */\nmodule.exports = {\n redirectStrategy: '404',\n useWordPressPlugin: true,\n\n sites: [\n {\n hostUrl: 'http://site1.localhost:3001',\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,\n\n },\n {\n hostUrl: 'http://site2.localhost:3001',\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL_2,\n },\n ],\n};\n")),(0,a.kt)("p",null,"In the example above we specify that all sites must use the WordPress plugin and that the redirect strategy should be ",(0,a.kt)("inlineCode",{parentName:"p"},"404"),". Then we're declaring two sites that will respond via the ",(0,a.kt)("a",{parentName:"p",href:"http://site1.localhost:3001"},"http://site1.localhost:3001")," and ",(0,a.kt)("a",{parentName:"p",href:"http://site2.localhost:3001"},"http://site2.localhost:3001")," URLs. The ",(0,a.kt)("inlineCode",{parentName:"p"},"sourceUrl")," for each comes from an env variable."),(0,a.kt)("p",null,"This means that when we visit ",(0,a.kt)("a",{parentName:"p",href:"http://site1.localhost:3001"},"http://site1.localhost:3001"),", the source URL specified by ",(0,a.kt)("inlineCode",{parentName:"p"},"NEXT_PUBLIC_HEADLESS_WP_URL")," will be used."),(0,a.kt)("h4",{id:"internationalized-routing"},"Internationalized routing"),(0,a.kt)("p",null,"If you're using ",(0,a.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/advanced-features/i18n-routing"},"Next.js i18n")," feature you can specify the locale in the site's config object and the locale will also be used when matching a site."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"/**\n * Headless Config\n *\n * @type {import('@headstartwp/core').HeadlessConfig}\n */\nmodule.exports = {\n redirectStrategy: '404',\n useWordPressPlugin: true,\n\n sites: [\n {\n hostUrl: 'http://site1.localhost:3001',\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,\n locale: 'en'\n },\n {\n hostUrl: 'http://site1.localhost:3001',\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL_2,\n locale: 'es'\n },\n ],\n};\n")),(0,a.kt)("p",null,"The above config means that ",(0,a.kt)("inlineCode",{parentName:"p"},"http://site1.localhost:3001/en")," will match the first site config and ",(0,a.kt)("inlineCode",{parentName:"p"},"http://site1.localhost:3001/es")," will match the second site config."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"Note"),": You must declare those locales in Next.js config. See ",(0,a.kt)("a",{parentName:"p",href:"https://nextjs.org/learn/advanced-features/i18n-routing"},"Next.js documentation")," for more information."),(0,a.kt)("p",null,"When using locales make sure to add the locale to ",(0,a.kt)("inlineCode",{parentName:"p"},"Settings -> General -> Headless Multisite Locale (optional)"),". This is required for previews and the revalidate handler to work properly since API routes are not localized in Next.js."),(0,a.kt)("p",null,"As an example, the first site config in the example above would need the following settings in WordPress."),(0,a.kt)("p",null,(0,a.kt)("img",{alt:"Plugin settings Multisite Locale",src:n(6078).Z,width:"759",height:"349"})),(0,a.kt)("h3",{id:"middleware"},"Middleware"),(0,a.kt)("p",null,"Make sure you have the framework's middleware setup at ",(0,a.kt)("inlineCode",{parentName:"p"},"src/middleware.js"),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"import { AppMiddleware } from '@headstartwp/next/middlewares';\n\nexport const config = {\n matcher: [\n /*\n * Match all paths except for:\n * 1. /api routes\n * 2. /_next (Next.js internals)\n * 3. /fonts (inside /public)\n * 4. all root files inside /public (e.g. /favicon.ico)\n */\n '/((?!api|_next|fonts[\\\\w-]+\\\\.\\\\w+).*)',\n ],\n};\n\nexport async function middleware(...args) {\n return AppMiddleware(...args);\n}\n")),(0,a.kt)("h3",{id:"folder-structure"},"Folder structure"),(0,a.kt)("p",null,"Put all of your page routes in ",(0,a.kt)("inlineCode",{parentName:"p"},"_sites/[site]/")," folder with the exception of the following files"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"_app.js"),(0,a.kt)("li",{parentName:"ul"},"_document.js"),(0,a.kt)("li",{parentName:"ul"},"404.js"),(0,a.kt)("li",{parentName:"ul"},"500.js"),(0,a.kt)("li",{parentName:"ul"},"api/")),(0,a.kt)("p",null," This should give you a structure similar to"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"_sites/\n\u251c\u2500 [site]/\n\u2502 \u251c\u2500 [...path].js\n\u2502 \u251c\u2500 index.js\n_app.js\n_document.js\n404.js\n500.js\napi/\n")),(0,a.kt)("p",null,"With this setup, the framework's middleware will rewrite all requests to ",(0,a.kt)("inlineCode",{parentName:"p"},"_sites/hostName"),". All of the data-fetching hooks will fetch data to the appropriate WordPress instance."),(0,a.kt)("p",null,"This allows you to power all of your sites with the same codebase. This is very useful if you're building sites that support internationalization or if the only thing that changes across sites is the content."),(0,a.kt)("h3",{id:"creating-routes-that-target-a-specific-site"},"Creating Routes that target a specific site"),(0,a.kt)("p",null,"It is possible to create routes specific to each site. To do this simply create a folder for that particular site eg: ",(0,a.kt)("inlineCode",{parentName:"p"},"src/pages/_sites/mysite.com/index.js"),". Then when a user visits ",(0,a.kt)("inlineCode",{parentName:"p"},"mysite.com")," the ",(0,a.kt)("inlineCode",{parentName:"p"},"index.js")," route file will be used instead of the one in ",(0,a.kt)("inlineCode",{parentName:"p"},"[site]/index.js"),"."),(0,a.kt)("p",null,"This provides a powerful way of powering complex multi-tenant apps that shares a codebase but render completely different pages and layouts."),(0,a.kt)("h2",{id:"known-issues"},"Known Issues"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"404.js and 500.js are unable to know the current site")),(0,a.kt)("p",null,"At the moment, there's a limitation in Next.js that doesn't allow the ",(0,a.kt)("inlineCode",{parentName:"p"},"404.js")," and ",(0,a.kt)("inlineCode",{parentName:"p"},"500.js")," pages to know the current site. These two files ",(0,a.kt)("strong",{parentName:"p"},"must")," be in the root of the pages directory and we can't rewrite them. Additionally, they only support ",(0,a.kt)("inlineCode",{parentName:"p"},"getStaticProps")," which means there's no way to know which site you're on in case you need to fetch data specific for that site."),(0,a.kt)("p",null,"If you need to fetch data in ",(0,a.kt)("inlineCode",{parentName:"p"},"404.js")," or ",(0,a.kt)("inlineCode",{parentName:"p"},"500.js")," there's one workaround but it relies on client-side data-fetching. In ",(0,a.kt)("inlineCode",{parentName:"p"},"_app.js")," do the following:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-javascript"},"import { getSiteByHost } from '@headstartwp/core';\n\n//grab the current site\nconst currentSite = useMemo(() => {\n if (router.query?.site && !Array.isArray(router.query.site)) {\n return getSiteByHost(router.query.site, router.locale);\n }\n\n // 404.js and 500.js do not have a site query param.\n if (typeof window !== 'undefined') {\n return getSiteByHost(window.location.host, router.locale);\n }\n return {};\n}, [router]);\n\n// pass it to HeadlessApp to override the current site settings defined by the framework\n// once react hydrates and window is defined, the currentSite will be set for 404 and 500 poages.\n\n")))}d.isMDXComponent=!0},6078:(e,t,n)=>{n.d(t,{Z:()=>r});const r=n.p+"assets/images/multisite-locale-60d679b73933b2e528aac602efd6e3d6.png"}}]); \ No newline at end of file diff --git a/assets/js/d9995696.d28adc04.js b/assets/js/d9995696.8df13123.js similarity index 98% rename from assets/js/d9995696.d28adc04.js rename to assets/js/d9995696.8df13123.js index 5af7b83a3..7c5862692 100644 --- a/assets/js/d9995696.d28adc04.js +++ b/assets/js/d9995696.8df13123.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5234],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=n.createContext({}),l=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},s=function(e){var t=l(e.components);return n.createElement(p.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,p=e.parentName,s=c(e,["components","mdxType","originalType","parentName"]),d=l(r),f=a,m=d["".concat(p,".").concat(f)]||d[f]||u[f]||o;return r?n.createElement(m,i(i({ref:t},s),{},{components:r})):n.createElement(m,i({ref:t},s))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=f;var c={};for(var p in t)hasOwnProperty.call(t,p)&&(c[p]=t[p]);c.originalType=e,c[d]="string"==typeof e?e:a,i[1]=c;for(var l=2;l{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var n=r(7462),a=(r(7294),r(3905));const o={id:"headstartwp_core.Integration",title:"Interface: Integration",sidebar_label:"@headstartwp/core.Integration",custom_edit_url:null},i=void 0,c={unversionedId:"interfaces/headstartwp_core.Integration",id:"interfaces/headstartwp_core.Integration",title:"Interface: Integration",description:"@headstartwp/core.Integration",source:"@site/docs/interfaces/headstartwp_core.Integration.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.Integration",permalink:"/docs/api/interfaces/headstartwp_core.Integration",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.Integration",title:"Interface: Integration",sidebar_label:"@headstartwp/core.Integration",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.HTMLReactParserOptions",permalink:"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions"},next:{title:"@headstartwp/core.MenuItemEntity",permalink:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"}},p={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"enable",id:"enable",level:3},{value:"Defined in",id:"defined-in",level:4}],s={toc:l};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".Integration"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Integration"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.YoastSEOIntegration"},(0,a.kt)("inlineCode",{parentName:"a"},"YoastSEOIntegration"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PolylangIntegration"},(0,a.kt)("inlineCode",{parentName:"a"},"PolylangIntegration"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"enable"},"enable"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"enable"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/types.ts#L46"},"packages/core/src/types.ts:46")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5234],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>m});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=n.createContext({}),l=function(e){var t=n.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},s=function(e){var t=l(e.components);return n.createElement(p.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,p=e.parentName,s=c(e,["components","mdxType","originalType","parentName"]),d=l(r),f=a,m=d["".concat(p,".").concat(f)]||d[f]||u[f]||o;return r?n.createElement(m,i(i({ref:t},s),{},{components:r})):n.createElement(m,i({ref:t},s))}));function m(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=f;var c={};for(var p in t)hasOwnProperty.call(t,p)&&(c[p]=t[p]);c.originalType=e,c[d]="string"==typeof e?e:a,i[1]=c;for(var l=2;l{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>d,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var n=r(7462),a=(r(7294),r(3905));const o={id:"headstartwp_core.Integration",title:"Interface: Integration",sidebar_label:"@headstartwp/core.Integration",custom_edit_url:null},i=void 0,c={unversionedId:"interfaces/headstartwp_core.Integration",id:"interfaces/headstartwp_core.Integration",title:"Interface: Integration",description:"@headstartwp/core.Integration",source:"@site/docs/interfaces/headstartwp_core.Integration.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.Integration",permalink:"/docs/api/interfaces/headstartwp_core.Integration",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.Integration",title:"Interface: Integration",sidebar_label:"@headstartwp/core.Integration",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.HTMLReactParserOptions",permalink:"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions"},next:{title:"@headstartwp/core.MenuItemEntity",permalink:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"}},p={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"enable",id:"enable",level:3},{value:"Defined in",id:"defined-in",level:4}],s={toc:l};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".Integration"),(0,a.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("inlineCode",{parentName:"strong"},"Integration"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.YoastSEOIntegration"},(0,a.kt)("inlineCode",{parentName:"a"},"YoastSEOIntegration"))),(0,a.kt)("p",{parentName:"li"},"\u21b3 ",(0,a.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PolylangIntegration"},(0,a.kt)("inlineCode",{parentName:"a"},"PolylangIntegration"))))),(0,a.kt)("h2",{id:"properties"},"Properties"),(0,a.kt)("h3",{id:"enable"},"enable"),(0,a.kt)("p",null,"\u2022 ",(0,a.kt)("strong",{parentName:"p"},"enable"),": ",(0,a.kt)("inlineCode",{parentName:"p"},"boolean")),(0,a.kt)("h4",{id:"defined-in"},"Defined in"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/types.ts#L46"},"packages/core/src/types.ts:46")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/d9f3c1c7.98fdd6cb.js b/assets/js/d9f3c1c7.a2d4c200.js similarity index 97% rename from assets/js/d9f3c1c7.98fdd6cb.js rename to assets/js/d9f3c1c7.a2d4c200.js index eb6aa1405..fec4e375e 100644 --- a/assets/js/d9f3c1c7.98fdd6cb.js +++ b/assets/js/d9f3c1c7.a2d4c200.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[62],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var l=a.createContext({}),p=function(e){var t=a.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},c=function(e){var t=p(e.components);return a.createElement(l.Provider,{value:t},e.children)},d="mdxType",f={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=p(r),u=n,h=d["".concat(l,".").concat(u)]||d[u]||f[u]||i;return r?a.createElement(h,o(o({ref:t},c),{},{components:r})):a.createElement(h,o({ref:t},c))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=u;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[d]="string"==typeof e?e:n,o[1]=s;for(var p=2;p{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>s,toc:()=>p});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.FilterDataOptions",title:"Interface: FilterDataOptions",sidebar_label:"@headstartwp/core.FilterDataOptions",custom_edit_url:null},o=void 0,s={unversionedId:"interfaces/headstartwp_core.FilterDataOptions",id:"interfaces/headstartwp_core.FilterDataOptions",title:"Interface: FilterDataOptions",description:"@headstartwp/core.FilterDataOptions",source:"@site/docs/interfaces/headstartwp_core.FilterDataOptions.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.FilterDataOptions",permalink:"/docs/api/interfaces/headstartwp_core.FilterDataOptions",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.FilterDataOptions",title:"Interface: FilterDataOptions",sidebar_label:"@headstartwp/core.FilterDataOptions",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.FetchResponse",permalink:"/docs/api/interfaces/headstartwp_core.FetchResponse"},next:{title:"@headstartwp/core.HTMLReactParserOptions",permalink:"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions"}},l={},p=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"fields",id:"fields",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"method",id:"method",level:3},{value:"Defined in",id:"defined-in-1",level:4}],c={toc:p};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".FilterDataOptions"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"fields"},"fields"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"fields"),": keyof ",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L94"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:94")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"method"},"method"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"method"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"ALLOW"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"REMOVE"')),(0,n.kt)("p",null,"If method is 'ALLOW' then only the fields specified in the filter will be returned.\nIf method is 'REMOVE' then the fields specified in the filter will be removed."),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L93"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:93")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[62],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var l=a.createContext({}),p=function(e){var t=a.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},c=function(e){var t=p(e.components);return a.createElement(l.Provider,{value:t},e.children)},d="mdxType",f={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=p(r),u=n,h=d["".concat(l,".").concat(u)]||d[u]||f[u]||i;return r?a.createElement(h,o(o({ref:t},c),{},{components:r})):a.createElement(h,o({ref:t},c))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=u;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[d]="string"==typeof e?e:n,o[1]=s;for(var p=2;p{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>s,toc:()=>p});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.FilterDataOptions",title:"Interface: FilterDataOptions",sidebar_label:"@headstartwp/core.FilterDataOptions",custom_edit_url:null},o=void 0,s={unversionedId:"interfaces/headstartwp_core.FilterDataOptions",id:"interfaces/headstartwp_core.FilterDataOptions",title:"Interface: FilterDataOptions",description:"@headstartwp/core.FilterDataOptions",source:"@site/docs/interfaces/headstartwp_core.FilterDataOptions.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.FilterDataOptions",permalink:"/docs/api/interfaces/headstartwp_core.FilterDataOptions",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.FilterDataOptions",title:"Interface: FilterDataOptions",sidebar_label:"@headstartwp/core.FilterDataOptions",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.FetchResponse",permalink:"/docs/api/interfaces/headstartwp_core.FetchResponse"},next:{title:"@headstartwp/core.HTMLReactParserOptions",permalink:"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions"}},l={},p=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"fields",id:"fields",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"method",id:"method",level:3},{value:"Defined in",id:"defined-in-1",level:4}],c={toc:p};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".FilterDataOptions"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"fields"},"fields"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"fields"),": keyof ",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[]"),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L94"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:94")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"method"},"method"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"method"),": ",(0,n.kt)("inlineCode",{parentName:"p"},'"ALLOW"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"REMOVE"')),(0,n.kt)("p",null,"If method is 'ALLOW' then only the fields specified in the filter will be returned.\nIf method is 'REMOVE' then the fields specified in the filter will be removed."),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L93"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:93")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/dcac5d89.a0a98b83.js b/assets/js/dcac5d89.f9af7894.js similarity index 87% rename from assets/js/dcac5d89.a0a98b83.js rename to assets/js/dcac5d89.f9af7894.js index a92473f0a..6aa30d589 100644 --- a/assets/js/dcac5d89.a0a98b83.js +++ b/assets/js/dcac5d89.f9af7894.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7137],{3905:(e,t,a)=>{a.d(t,{Zo:()=>l,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var s=n.createContext({}),c=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},l=function(e){var t=c(e.components);return n.createElement(s.Provider,{value:t},e.children)},d="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},y=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,l=o(e,["components","mdxType","originalType","parentName"]),d=c(a),y=r,h=d["".concat(s,".").concat(y)]||d[y]||m[y]||i;return a?n.createElement(h,p(p({ref:t},l),{},{components:a})):n.createElement(h,p({ref:t},l))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,p=new Array(i);p[0]=y;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o[d]="string"==typeof e?e:r,p[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.Entity",title:"Interface: Entity",sidebar_label:"@headstartwp/core.Entity",custom_edit_url:null},p=void 0,o={unversionedId:"interfaces/headstartwp_core.Entity",id:"interfaces/headstartwp_core.Entity",title:"Interface: Entity",description:"@headstartwp/core.Entity",source:"@site/docs/interfaces/headstartwp_core.Entity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.Entity",permalink:"/docs/api/interfaces/headstartwp_core.Entity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.Entity",title:"Interface: Entity",sidebar_label:"@headstartwp/core.Entity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.EndpointParams",permalink:"/docs/api/interfaces/headstartwp_core.EndpointParams"},next:{title:"@headstartwp/core.FetchOptions",permalink:"/docs/api/interfaces/headstartwp_core.FetchOptions"}},s={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"yoast_head",id:"yoast_head",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Defined in",id:"defined-in-1",level:4}],l={toc:c};function d(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},l,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".Entity"),(0,r.kt)("p",null,"Empty interface from which all entities inherit."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Entity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostTypeEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TypeEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TypeEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TaxonomyEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TaxonomyEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.CommentEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"CommentEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"SearchEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"SearchObjectEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AppEntity"))))),(0,r.kt)("h2",{id:"indexable"},"Indexable"),(0,r.kt)("p",null,"\u25aa ","[k: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7137],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var s=n.createContext({}),l=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},c=function(e){var t=l(e.components);return n.createElement(s.Provider,{value:t},e.children)},d="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},y=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,c=o(e,["components","mdxType","originalType","parentName"]),d=l(a),y=r,h=d["".concat(s,".").concat(y)]||d[y]||m[y]||i;return a?n.createElement(h,p(p({ref:t},c),{},{components:a})):n.createElement(h,p({ref:t},c))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,p=new Array(i);p[0]=y;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o[d]="string"==typeof e?e:r,p[1]=o;for(var l=2;l{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>p,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>l});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.Entity",title:"Interface: Entity",sidebar_label:"@headstartwp/core.Entity",custom_edit_url:null},p=void 0,o={unversionedId:"interfaces/headstartwp_core.Entity",id:"interfaces/headstartwp_core.Entity",title:"Interface: Entity",description:"@headstartwp/core.Entity",source:"@site/docs/interfaces/headstartwp_core.Entity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.Entity",permalink:"/docs/api/interfaces/headstartwp_core.Entity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.Entity",title:"Interface: Entity",sidebar_label:"@headstartwp/core.Entity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.EndpointParams",permalink:"/docs/api/interfaces/headstartwp_core.EndpointParams"},next:{title:"@headstartwp/core.FetchOptions",permalink:"/docs/api/interfaces/headstartwp_core.FetchOptions"}},s={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Indexable",id:"indexable",level:2},{value:"Properties",id:"properties",level:2},{value:"yoast_head",id:"yoast_head",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Defined in",id:"defined-in-1",level:4}],c={toc:l};function d(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".Entity"),(0,r.kt)("p",null,"Empty interface from which all entities inherit."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"Entity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostTypeEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"PostTypeEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TypeEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TypeEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TaxonomyEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TaxonomyEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.TermEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"TermEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AuthorEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AuthorEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.CommentEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"CommentEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"SearchEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"SearchObjectEntity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,r.kt)("inlineCode",{parentName:"a"},"AppEntity"))))),(0,r.kt)("h2",{id:"indexable"},"Indexable"),(0,r.kt)("p",null,"\u25aa ","[k: ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"]",": ",(0,r.kt)("inlineCode",{parentName:"p"},"unknown")),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/def27140.d4e71e51.js b/assets/js/def27140.cf696206.js similarity index 97% rename from assets/js/def27140.d4e71e51.js rename to assets/js/def27140.cf696206.js index 964f67cd5..2c5f8011f 100644 --- a/assets/js/def27140.d4e71e51.js +++ b/assets/js/def27140.cf696206.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5593],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function o(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||l;return a?r.createElement(h,o(o({ref:t},d),{},{components:a})):r.createElement(h,o({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,o=new Array(l);o[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:n,o[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>l,metadata:()=>i,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.IPullQuoteBlock",title:"Interface: IPullQuoteBlock",sidebar_label:"@headstartwp/core.react.IPullQuoteBlock",custom_edit_url:null},o=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IPullQuoteBlock",id:"interfaces/headstartwp_core.react.IPullQuoteBlock",title:"Interface: IPullQuoteBlock",description:"@headstartwp/core.react.IPullQuoteBlock",source:"@site/docs/interfaces/headstartwp_core.react.IPullQuoteBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IPullQuoteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IPullQuoteBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IPullQuoteBlock",title:"Interface: IPullQuoteBlock",sidebar_label:"@headstartwp/core.react.IPullQuoteBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IPreformattedBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IPreformattedBlock"},next:{title:"@headstartwp/core.react.IQuoteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IQuoteBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IPullQuoteBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PullQuoteBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IPullQuoteBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PullQuoteBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PullQuoteBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5593],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function o(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):o(o({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||l;return a?r.createElement(h,o(o({ref:t},d),{},{components:a})):r.createElement(h,o({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,o=new Array(l);o[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:n,o[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>s,frontMatter:()=>l,metadata:()=>i,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.IPullQuoteBlock",title:"Interface: IPullQuoteBlock",sidebar_label:"@headstartwp/core.react.IPullQuoteBlock",custom_edit_url:null},o=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IPullQuoteBlock",id:"interfaces/headstartwp_core.react.IPullQuoteBlock",title:"Interface: IPullQuoteBlock",description:"@headstartwp/core.react.IPullQuoteBlock",source:"@site/docs/interfaces/headstartwp_core.react.IPullQuoteBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IPullQuoteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IPullQuoteBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IPullQuoteBlock",title:"Interface: IPullQuoteBlock",sidebar_label:"@headstartwp/core.react.IPullQuoteBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IPreformattedBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IPreformattedBlock"},next:{title:"@headstartwp/core.react.IQuoteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IQuoteBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IPullQuoteBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PullQuoteBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IPullQuoteBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PullQuoteBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"PullQuoteBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e088eb77.fd7bf233.js b/assets/js/e088eb77.fba15cbc.js similarity index 96% rename from assets/js/e088eb77.fd7bf233.js rename to assets/js/e088eb77.fba15cbc.js index 075c1f3f1..f969c4d47 100644 --- a/assets/js/e088eb77.fd7bf233.js +++ b/assets/js/e088eb77.fba15cbc.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8089],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||l;return a?r.createElement(h,i(i({ref:t},d),{},{components:a})):r.createElement(h,i({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,i=new Array(l);i[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.IVerseBlock",title:"Interface: IVerseBlock",sidebar_label:"@headstartwp/core.react.IVerseBlock",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.IVerseBlock",id:"interfaces/headstartwp_core.react.IVerseBlock",title:"Interface: IVerseBlock",description:"@headstartwp/core.react.IVerseBlock",source:"@site/docs/interfaces/headstartwp_core.react.IVerseBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IVerseBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IVerseBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IVerseBlock",title:"Interface: IVerseBlock",sidebar_label:"@headstartwp/core.react.IVerseBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ITableBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ITableBlock"},next:{title:"@headstartwp/core.react.IYoutubeLiteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IVerseBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"VerseBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IVerseBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"VerseBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"VerseBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8089],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function l(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var p=r.createContext({}),c=function(e){var t=r.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},d=function(e){var t=c(e.components);return r.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,l=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(a),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||l;return a?r.createElement(h,i(i({ref:t},d),{},{components:a})):r.createElement(h,i({ref:t},d))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var l=a.length,i=new Array(l);i[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,i[1]=o;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>s,frontMatter:()=>l,metadata:()=>o,toc:()=>c});var r=a(7462),n=(a(7294),a(3905));const l={id:"headstartwp_core.react.IVerseBlock",title:"Interface: IVerseBlock",sidebar_label:"@headstartwp/core.react.IVerseBlock",custom_edit_url:null},i=void 0,o={unversionedId:"interfaces/headstartwp_core.react.IVerseBlock",id:"interfaces/headstartwp_core.react.IVerseBlock",title:"Interface: IVerseBlock",description:"@headstartwp/core.react.IVerseBlock",source:"@site/docs/interfaces/headstartwp_core.react.IVerseBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IVerseBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IVerseBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IVerseBlock",title:"Interface: IVerseBlock",sidebar_label:"@headstartwp/core.react.IVerseBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ITableBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ITableBlock"},next:{title:"@headstartwp/core.react.IYoutubeLiteBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IVerseBlock"),(0,n.kt)("p",null,"The common interface for a block transform component"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"VerseBlockProps")),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"IVerseBlock"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,n.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classlist"},"classList"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"classList"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,n.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"component"},"component"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"component"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"VerseBlockProps")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h5",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"props")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps"},(0,n.kt)("inlineCode",{parentName:"a"},"VerseBlockProps")))))),(0,n.kt)("h5",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"exclude"},"exclude"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"exclude"),": (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("p",null,"\u25b8 (",(0,n.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,n.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,n.kt)("h5",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"childNode")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"site?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,n.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,n.kt)("h5",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("p",null,"The style tag of the domNode as an object."),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,n.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e4594716.da8c3487.js b/assets/js/e4594716.97fb8eff.js similarity index 95% rename from assets/js/e4594716.da8c3487.js rename to assets/js/e4594716.97fb8eff.js index f759b58e5..9d8fe466c 100644 --- a/assets/js/e4594716.da8c3487.js +++ b/assets/js/e4594716.97fb8eff.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6623],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var d=r.createContext({}),l=function(e){var t=r.useContext(d),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=l(e.components);return r.createElement(d.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},k=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,d=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),c=l(a),k=n,h=c["".concat(d,".").concat(k)]||c[k]||m[k]||i;return a?r.createElement(h,p(p({ref:t},o),{},{components:a})):r.createElement(h,p({ref:t},o))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=k;var s={};for(var d in t)hasOwnProperty.call(t,d)&&(s[d]=t[d]);s.originalType=e,s[c]="string"==typeof e?e:n,p[1]=s;for(var l=2;l{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.PostOrPostsFetchStrategy",title:"Class: PostOrPostsFetchStrategy",sidebar_label:"@headstartwp/core.PostOrPostsFetchStrategy",custom_edit_url:null},p=void 0,s={unversionedId:"classes/headstartwp_core.PostOrPostsFetchStrategy",id:"classes/headstartwp_core.PostOrPostsFetchStrategy",title:"Class: PostOrPostsFetchStrategy",description:"@headstartwp/core.PostOrPostsFetchStrategy",source:"@site/docs/classes/headstartwp_core.PostOrPostsFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.PostOrPostsFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostOrPostsFetchStrategy",title:"Class: PostOrPostsFetchStrategy",sidebar_label:"@headstartwp/core.PostOrPostsFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.NotFoundError",permalink:"/docs/api/classes/headstartwp_core.NotFoundError"},next:{title:"@headstartwp/core.PostsArchiveFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"}},d={},l=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"postStrategy",id:"poststrategy",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"postsStrategy",id:"postsstrategy",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"urlParams",id:"urlparams",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"fetchArchive",id:"fetcharchive",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"fetchSingle",id:"fetchsingle",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"getPreviewAuthHeader",id:"getpreviewauthheader",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"getPreviewHeaderName",id:"getpreviewheadername",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-26",level:4}],o={toc:l};function c(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostOrPostsFetchStrategy"),(0,n.kt)("p",null,"This fetch strategy does not support extracting url params from the url"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsParams")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"R")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#postorpostsfetchstrategyresult"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsFetchStrategyResult")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">"," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#postorpostsfetchstrategyresult"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsFetchStrategyResult")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">")))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"PostOrPostsFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new PostOrPostsFetchStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsParams")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"R")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#postorpostsfetchstrategyresult"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsFetchStrategyResult")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">"," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#postorpostsfetchstrategyresult"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsFetchStrategyResult")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">")))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L143"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:143")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L119"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:119")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L124"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:124")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"poststrategy"},"postStrategy"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"postStrategy"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"SinglePostFetchStrategy")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")),", ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams")),">"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L60"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:60")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"postsstrategy"},"postsStrategy"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"postsStrategy"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveFetchStrategy")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")),", ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")),">"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L62"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:62")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"urlparams"},"urlParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"urlParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L58"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:58")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Builds the final endpoint URL based on the passed parameters"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to add to the request")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The endpoint URL."),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L220"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:220")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcharchive"},"fetchArchive"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetchArchive"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,n.kt)("inlineCode",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"R")," }",">"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,n.kt)("inlineCode",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"R")," }",">"),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L145"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:145")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetchsingle"},"fetchSingle"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetchSingle"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,n.kt)("inlineCode",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"R")," }",">"),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,n.kt)("inlineCode",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"R")," }",">"),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L132"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:132")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("p",null,"The default fetcher function"),(0,n.kt)("p",null,"The default fetcher function handles authentication headers and errors from the API."),(0,n.kt)("p",null,"A custom strategy can override this function to run additional logic before or after the fetch call"),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL to fetch")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetcher options")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L158"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:158")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"filterOptions?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"filterOptions?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L377"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:377")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L442"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:442")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L256"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:256")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L407"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:407")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L64"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:64")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L182"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:182")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L174"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:174")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Returns the supported params from the URL if present."),(0,n.kt)("p",null,"These params are passed to ",(0,n.kt)("inlineCode",{parentName:"p"},"buildEndpointURL"),". If the strategy does not support\nmapping url params to endpoint params, it should return an empty object."),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The Path name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"params extracted from the URL"),(0,n.kt)("h4",{id:"overrides-2"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L68"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:68")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewauthheader"},"getPreviewAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getpreviewauthheader"},"getPreviewAuthHeader")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L247"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:247")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewheadername"},"getPreviewHeaderName"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewHeaderName"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getpreviewheadername"},"getPreviewHeaderName")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L241"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:241")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L365"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:365")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L205"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:205")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-14"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-16"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides-3"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L77"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("h4",{id:"parameters-15"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-17"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L233"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:233")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-16"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-18"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L164"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:164")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-17"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-19"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6623],{3905:(e,t,a)=>{a.d(t,{Zo:()=>o,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function p(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var l=r.createContext({}),d=function(e){var t=r.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},o=function(e){var t=d(e.components);return r.createElement(l.Provider,{value:t},e.children)},m="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,l=e.parentName,o=s(e,["components","mdxType","originalType","parentName"]),m=d(a),c=n,h=m["".concat(l,".").concat(c)]||m[c]||k[c]||i;return a?r.createElement(h,p(p({ref:t},o),{},{components:a})):r.createElement(h,p({ref:t},o))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,p=new Array(i);p[0]=c;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[m]="string"==typeof e?e:n,p[1]=s;for(var d=2;d{a.r(t),a.d(t,{assets:()=>l,contentTitle:()=>p,default:()=>m,frontMatter:()=>i,metadata:()=>s,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.PostOrPostsFetchStrategy",title:"Class: PostOrPostsFetchStrategy",sidebar_label:"@headstartwp/core.PostOrPostsFetchStrategy",custom_edit_url:null},p=void 0,s={unversionedId:"classes/headstartwp_core.PostOrPostsFetchStrategy",id:"classes/headstartwp_core.PostOrPostsFetchStrategy",title:"Class: PostOrPostsFetchStrategy",description:"@headstartwp/core.PostOrPostsFetchStrategy",source:"@site/docs/classes/headstartwp_core.PostOrPostsFetchStrategy.md",sourceDirName:"classes",slug:"/classes/headstartwp_core.PostOrPostsFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.PostOrPostsFetchStrategy",title:"Class: PostOrPostsFetchStrategy",sidebar_label:"@headstartwp/core.PostOrPostsFetchStrategy",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.NotFoundError",permalink:"/docs/api/classes/headstartwp_core.NotFoundError"},next:{title:"@headstartwp/core.PostsArchiveFetchStrategy",permalink:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"}},l={},d=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"baseURL",id:"baseurl",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"defaultParams",id:"defaultparams",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"endpoint",id:"endpoint",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"postStrategy",id:"poststrategy",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"postsStrategy",id:"postsstrategy",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"urlParams",id:"urlparams",level:3},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"buildEndpointURL",id:"buildendpointurl",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns",level:4},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"fetchArchive",id:"fetcharchive",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"fetchSingle",id:"fetchsingle",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"fetcher",id:"fetcher",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"filterData",id:"filterdata",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"get",id:"get",level:3},{value:"Usage",id:"usage",level:2},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"getAuthHeader",id:"getauthheader",level:3},{value:"Parameters",id:"parameters-7",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"getCacheKey",id:"getcachekey",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"Defined in",id:"defined-in-14",level:4},{value:"getDefaultEndpoint",id:"getdefaultendpoint",level:3},{value:"Returns",id:"returns-8",level:4},{value:"Overrides",id:"overrides-1",level:4},{value:"Defined in",id:"defined-in-15",level:4},{value:"getDefaultParams",id:"getdefaultparams",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"Defined in",id:"defined-in-16",level:4},{value:"getEndpoint",id:"getendpoint",level:3},{value:"Returns",id:"returns-10",level:4},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"Defined in",id:"defined-in-17",level:4},{value:"getParamsFromURL",id:"getparamsfromurl",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-11",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"Defined in",id:"defined-in-18",level:4},{value:"getPreviewAuthHeader",id:"getpreviewauthheader",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"Defined in",id:"defined-in-19",level:4},{value:"getPreviewHeaderName",id:"getpreviewheadername",level:3},{value:"Parameters",id:"parameters-11",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"Defined in",id:"defined-in-20",level:4},{value:"getQueriedObject",id:"getqueriedobject",level:3},{value:"Parameters",id:"parameters-12",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Inherited from",id:"inherited-from-13",level:4},{value:"Defined in",id:"defined-in-21",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Parameters",id:"parameters-13",level:4},{value:"Returns",id:"returns-15",level:4},{value:"Inherited from",id:"inherited-from-14",level:4},{value:"Defined in",id:"defined-in-22",level:4},{value:"normalizeForCache",id:"normalizeforcache",level:3},{value:"Parameters",id:"parameters-14",level:4},{value:"Returns",id:"returns-16",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"Defined in",id:"defined-in-23",level:4},{value:"prepareResponse",id:"prepareresponse",level:3},{value:"Parameters",id:"parameters-15",level:4},{value:"Returns",id:"returns-17",level:4},{value:"Inherited from",id:"inherited-from-15",level:4},{value:"Defined in",id:"defined-in-24",level:4},{value:"setBaseURL",id:"setbaseurl",level:3},{value:"Parameters",id:"parameters-16",level:4},{value:"Returns",id:"returns-18",level:4},{value:"Inherited from",id:"inherited-from-16",level:4},{value:"Defined in",id:"defined-in-25",level:4},{value:"setEndpoint",id:"setendpoint",level:3},{value:"Parameters",id:"parameters-17",level:4},{value:"Returns",id:"returns-19",level:4},{value:"Inherited from",id:"inherited-from-17",level:4},{value:"Defined in",id:"defined-in-26",level:4}],o={toc:d};function m(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},o,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".PostOrPostsFetchStrategy"),(0,n.kt)("p",null,"This fetch strategy does not support extracting url params from the url"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsParams")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"R")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#postorpostsfetchstrategyresult"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsFetchStrategyResult")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">"," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#postorpostsfetchstrategyresult"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsFetchStrategyResult")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">")))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"AbstractFetchStrategy")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),"[], ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"PostOrPostsFetchStrategy"))))),(0,n.kt)("h2",{id:"constructors"},"Constructors"),(0,n.kt)("h3",{id:"constructor"},"constructor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"new PostOrPostsFetchStrategy"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">","(",(0,n.kt)("inlineCode",{parentName:"p"},"baseURL?"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"defaultParams?"),")"),(0,n.kt)("p",null,"The strategy constructor"),(0,n.kt)("h4",{id:"type-parameters-1"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"P")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsParams"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsParams")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"R")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#postorpostsfetchstrategyresult"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsFetchStrategyResult")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">"," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#postorpostsfetchstrategyresult"},(0,n.kt)("inlineCode",{parentName:"a"},"PostOrPostsFetchStrategyResult")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),">")))),(0,n.kt)("h4",{id:"parameters"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"baseURL?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The base URL of the API")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"defaultParams?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"(optional) list of default params")))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#constructor"},"constructor")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L143"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:143")),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"baseurl"},"baseURL"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"baseURL"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"The base URL where the API is located"),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#baseurl"},"baseURL")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L129"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:129")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"defaultparams"},"defaultParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"defaultParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("p",null,"The Default Params"),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#defaultparams"},"defaultParams")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L119"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:119")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"endpoint"},"endpoint"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"endpoint"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")," = ",(0,n.kt)("inlineCode",{parentName:"p"},"''")),(0,n.kt)("p",null,"Holds the current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#endpoint"},"endpoint")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L124"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:124")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"poststrategy"},"postStrategy"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"postStrategy"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"SinglePostFetchStrategy")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")),", ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams")),">"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L60"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:60")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"postsstrategy"},"postsStrategy"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"postsStrategy"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveFetchStrategy")),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")),", ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")),">"),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L62"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:62")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"urlparams"},"urlParams"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"urlParams"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"," = ",(0,n.kt)("inlineCode",{parentName:"p"},"{}")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L58"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:58")),(0,n.kt)("h2",{id:"methods"},"Methods"),(0,n.kt)("h3",{id:"buildendpointurl"},"buildEndpointURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"buildEndpointURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Builds the final endpoint URL based on the passed parameters"),(0,n.kt)("h4",{id:"parameters-1"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The params to add to the request")))),(0,n.kt)("h4",{id:"returns"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The endpoint URL."),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#buildendpointurl"},"buildEndpointURL")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L220"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:220")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcharchive"},"fetchArchive"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetchArchive"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,n.kt)("inlineCode",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"R")," }",">"),(0,n.kt)("h4",{id:"parameters-2"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostsArchiveParams")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-1"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,n.kt)("inlineCode",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"R")," }",">"),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L145"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:145")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetchsingle"},"fetchSingle"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetchSingle"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,n.kt)("inlineCode",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"R")," }",">"),(0,n.kt)("h4",{id:"parameters-3"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostParams"},(0,n.kt)("inlineCode",{parentName:"a"},"PostParams")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-2"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<{ ",(0,n.kt)("inlineCode",{parentName:"p"},"pageInfo"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.PageInfo"},(0,n.kt)("inlineCode",{parentName:"a"},"PageInfo"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"queriedObject"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#queriedobject"},(0,n.kt)("inlineCode",{parentName:"a"},"QueriedObject"))," ; ",(0,n.kt)("inlineCode",{parentName:"p"},"result"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"R")," }",">"),(0,n.kt)("h4",{id:"defined-in-9"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L132"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:132")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"fetcher"},"fetcher"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"fetcher"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("p",null,"The default fetcher function"),(0,n.kt)("p",null,"The default fetcher function handles authentication headers and errors from the API."),(0,n.kt)("p",null,"A custom strategy can override this function to run additional logic before or after the fetch call"),(0,n.kt)("h4",{id:"parameters-4"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The URL to fetch")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetcher options")))),(0,n.kt)("h4",{id:"returns-3"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#fetcher"},"fetcher")),(0,n.kt)("h4",{id:"defined-in-10"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L158"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:158")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"filterdata"},"filterData"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"filterData"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"filterOptions?"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("p",null,"Filters the data returned from the API by excluding fields that are not needed in order to reduce\npayload size."),(0,n.kt)("h4",{id:"parameters-5"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The data to filter")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"filterOptions?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FilterDataOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FilterDataOptions")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"Filter options")))),(0,n.kt)("h4",{id:"returns-4"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("p",null,"The filtered data"),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#filterdata"},"filterData")),(0,n.kt)("h4",{id:"defined-in-11"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L377"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:377")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"get"},"get"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"get"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("p",null,"This is a simple wrapper to quickly fetch data from the API given a set of params"),(0,n.kt)("h2",{id:"usage"},"Usage"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-tsx"},"import { PostsArchiveFetchStrategy } from '@headstartwp/core';\n\nnew PostsArchiveFetchStrategy('http://my-wp-url.com').get({perPage: 10});\n")),(0,n.kt)("h4",{id:"parameters-6"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint params")))),(0,n.kt)("h4",{id:"returns-5"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Promise"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">",">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#get"},"get")),(0,n.kt)("h4",{id:"defined-in-12"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L442"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:442")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getauthheader"},"getAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-7"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-6"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getauthheader"},"getAuthHeader")),(0,n.kt)("h4",{id:"defined-in-13"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L256"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:256")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getcachekey"},"getCacheKey"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getCacheKey"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"Returns the cache key with both the endpoint and the sourceUrl to distinguish between multiple sites"),(0,n.kt)("h4",{id:"parameters-8"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-7"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("p",null,"The cache key object"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"args")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"," & { ",(0,n.kt)("inlineCode",{parentName:"td"},"sourceUrl"),": ",(0,n.kt)("inlineCode",{parentName:"td"},"string")," }")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from-8"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getcachekey"},"getCacheKey")),(0,n.kt)("h4",{id:"defined-in-14"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L407"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:407")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultendpoint"},"getDefaultEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"A method that must be implemented by concrete implementations which returns the default endpoint\nfor the strategy"),(0,n.kt)("h4",{id:"returns-8"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"overrides-1"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultendpoint"},"getDefaultEndpoint")),(0,n.kt)("h4",{id:"defined-in-15"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L64"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:64")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getdefaultparams"},"getDefaultParams"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getDefaultParams"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"returns-9"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"inherited-from-9"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getdefaultparams"},"getDefaultParams")),(0,n.kt)("h4",{id:"defined-in-16"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L182"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:182")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getendpoint"},"getEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getEndpoint"),"(): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"Returns the endpoint of the strategy. If no endpoint has been set at runtime,\nreturns the default endpoint"),(0,n.kt)("h4",{id:"returns-10"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("p",null,"The current endpoint for the strategy"),(0,n.kt)("h4",{id:"inherited-from-10"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getendpoint"},"getEndpoint")),(0,n.kt)("h4",{id:"defined-in-17"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L174"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:174")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getparamsfromurl"},"getParamsFromURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getParamsFromURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Returns the supported params from the URL if present."),(0,n.kt)("p",null,"These params are passed to ",(0,n.kt)("inlineCode",{parentName:"p"},"buildEndpointURL"),". If the strategy does not support\nmapping url params to endpoint params, it should return an empty object."),(0,n.kt)("h4",{id:"parameters-9"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The Path name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-11"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"params extracted from the URL"),(0,n.kt)("h4",{id:"overrides-2"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getparamsfromurl"},"getParamsFromURL")),(0,n.kt)("h4",{id:"defined-in-18"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L68"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:68")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewauthheader"},"getPreviewAuthHeader"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewAuthHeader"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"parameters-10"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-12"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-11"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getpreviewauthheader"},"getPreviewAuthHeader")),(0,n.kt)("h4",{id:"defined-in-19"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L247"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:247")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getpreviewheadername"},"getPreviewHeaderName"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getPreviewHeaderName"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"options?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"parameters-11"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"options")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchOptions"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchOptions")),">")))),(0,n.kt)("h4",{id:"returns-13"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},'"X-HeadstartWP-Authorization"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"p"},'"Authorization"')),(0,n.kt)("h4",{id:"inherited-from-12"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getpreviewheadername"},"getPreviewHeaderName")),(0,n.kt)("h4",{id:"defined-in-20"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L241"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:241")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"getqueriedobject"},"getQueriedObject"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"getQueriedObject"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"parameters-12"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-14"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"inherited-from-13"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#getqueriedobject"},"getQueriedObject")),(0,n.kt)("h4",{id:"defined-in-21"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L365"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:365")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"path"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"nonUrlParams"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("p",null,"Checks if this is the main query for a page"),(0,n.kt)("h4",{id:"parameters-13"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"path")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The page name")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"nonUrlParams")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The non-url params")))),(0,n.kt)("h4",{id:"returns-15"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-14"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-22"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L205"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:205")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"normalizeforcache"},"normalizeForCache"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"normalizeForCache"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"data"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("p",null,"Normalize data for cache."),(0,n.kt)("h4",{id:"parameters-14"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"data")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"R"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The fetch response data")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">"),(0,n.kt)("td",{parentName:"tr",align:"left"},"The request params")))),(0,n.kt)("h4",{id:"returns-16"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#normalizeddataforcache"},(0,n.kt)("inlineCode",{parentName:"a"},"NormalizedDataForCache")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"P"),">"),(0,n.kt)("h4",{id:"overrides-3"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#normalizeforcache"},"normalizeForCache")),(0,n.kt)("h4",{id:"defined-in-23"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts#L77"},"packages/core/src/data/strategies/PostOrPostsFetchStrategy.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"prepareresponse"},"prepareResponse"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"prepareResponse"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"response"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"params"),"): ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("h4",{id:"parameters-15"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"response")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]",">")),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"params")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"Partial"),"<",(0,n.kt)("inlineCode",{parentName:"td"},"P"),">")))),(0,n.kt)("h4",{id:"returns-17"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"R"),">"),(0,n.kt)("h4",{id:"inherited-from-15"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#prepareresponse"},"prepareResponse")),(0,n.kt)("h4",{id:"defined-in-24"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L233"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:233")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setbaseurl"},"setBaseURL"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setBaseURL"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"url?"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"parameters-16"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Default value"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"url")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"undefined")," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"''"))))),(0,n.kt)("h4",{id:"returns-18"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-16"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setbaseurl"},"setBaseURL")),(0,n.kt)("h4",{id:"defined-in-25"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L164"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:164")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"setendpoint"},"setEndpoint"),(0,n.kt)("p",null,"\u25b8 ",(0,n.kt)("strong",{parentName:"p"},"setEndpoint"),"(",(0,n.kt)("inlineCode",{parentName:"p"},"endpoint"),"): ",(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("p",null,"The strategy can switch endpoints at runtime if needed."),(0,n.kt)("p",null,"E.g: The actual endpoint for a post depends on its post_type"),(0,n.kt)("h4",{id:"parameters-17"},"Parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Description"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"endpoint")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string")),(0,n.kt)("td",{parentName:"tr",align:"left"},"The endpoint to fetch")))),(0,n.kt)("h4",{id:"returns-19"},"Returns"),(0,n.kt)("p",null,(0,n.kt)("inlineCode",{parentName:"p"},"void")),(0,n.kt)("h4",{id:"inherited-from-17"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy"},"AbstractFetchStrategy"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy#setendpoint"},"setEndpoint")),(0,n.kt)("h4",{id:"defined-in-26"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/strategies/AbstractFetchStrategy.ts#L160"},"packages/core/src/data/strategies/AbstractFetchStrategy.ts:160")))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e518cb64.de2a34cf.js b/assets/js/e518cb64.f653cb95.js similarity index 97% rename from assets/js/e518cb64.de2a34cf.js rename to assets/js/e518cb64.f653cb95.js index 883659a1e..83aa14f56 100644 --- a/assets/js/e518cb64.de2a34cf.js +++ b/assets/js/e518cb64.f653cb95.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[984],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),c=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return n.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=r,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||o;return a?n.createElement(h,l(l({ref:t},d),{},{components:a})):n.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=a.length,l=new Array(o);l[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:r,l[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var n=a(7462),r=(a(7294),a(3905));const o={id:"headstartwp_core.react.IButtonBlock",title:"Interface: IButtonBlock",sidebar_label:"@headstartwp/core.react.IButtonBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IButtonBlock",id:"interfaces/headstartwp_core.react.IButtonBlock",title:"Interface: IButtonBlock",description:"@headstartwp/core.react.IButtonBlock",source:"@site/docs/interfaces/headstartwp_core.react.IButtonBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IButtonBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IButtonBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IButtonBlock",title:"Interface: IButtonBlock",sidebar_label:"@headstartwp/core.react.IButtonBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IBlockAttributes",permalink:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},next:{title:"@headstartwp/core.react.IButtonsBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IButtonsBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IButtonBlock"),(0,r.kt)("p",null,"The common interface for a block transform component"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ButtonBlockProps")),">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"IButtonBlock"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"children"},"children"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"children"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,r.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,r.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classlist"},"classList"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"classList"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classname"},"className"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"className"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"component"},"component"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"component"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ButtonBlockProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ButtonBlockProps")))))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domnode"},"domNode"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"domNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,r.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,r.kt)("h5",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"childNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h5",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"style"},"style"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"style"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The style tag of the domNode as an object."),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tagname"},"tagName"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tagName"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[984],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),c=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return n.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=r,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||o;return a?n.createElement(h,l(l({ref:t},d),{},{components:a})):n.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=a.length,l=new Array(o);l[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:r,l[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var n=a(7462),r=(a(7294),a(3905));const o={id:"headstartwp_core.react.IButtonBlock",title:"Interface: IButtonBlock",sidebar_label:"@headstartwp/core.react.IButtonBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IButtonBlock",id:"interfaces/headstartwp_core.react.IButtonBlock",title:"Interface: IButtonBlock",description:"@headstartwp/core.react.IButtonBlock",source:"@site/docs/interfaces/headstartwp_core.react.IButtonBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IButtonBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IButtonBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IButtonBlock",title:"Interface: IButtonBlock",sidebar_label:"@headstartwp/core.react.IButtonBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IBlockAttributes",permalink:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},next:{title:"@headstartwp/core.react.IButtonsBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IButtonsBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IButtonBlock"),(0,r.kt)("p",null,"The common interface for a block transform component"),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ButtonBlockProps")),">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"IButtonBlock"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"children"},"children"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"children"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,r.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,r.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classlist"},"classList"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"classList"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classname"},"className"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"className"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"component"},"component"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"component"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ButtonBlockProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ButtonBlockProps")))))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domnode"},"domNode"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"domNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,r.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,r.kt)("h5",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"childNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h5",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"style"},"style"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"style"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The style tag of the domNode as an object."),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tagname"},"tagName"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tagName"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/eb775807.258914a8.js b/assets/js/eb775807.258914a8.js new file mode 100644 index 000000000..904d65978 --- /dev/null +++ b/assets/js/eb775807.258914a8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8743],{3905:(e,t,r)=>{r.d(t,{Zo:()=>l,kt:()=>k});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function p(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function s(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var i=a.createContext({}),c=function(e){var t=a.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},l=function(e){var t=c(e.components);return a.createElement(i.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,p=e.originalType,i=e.parentName,l=o(e,["components","mdxType","originalType","parentName"]),d=c(r),h=n,k=d["".concat(i,".").concat(h)]||d[h]||u[h]||p;return r?a.createElement(k,s(s({ref:t},l),{},{components:r})):a.createElement(k,s({ref:t},l))}));function k(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var p=r.length,s=new Array(p);s[0]=h;var o={};for(var i in t)hasOwnProperty.call(t,i)&&(o[i]=t[i]);o.originalType=e,o[d]="string"==typeof e?e:n,s[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>s,default:()=>d,frontMatter:()=>p,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const p={id:"headstartwp_core.react.useAppSettingsResponse",title:"Interface: useAppSettingsResponse",sidebar_label:"@headstartwp/core.react.useAppSettingsResponse",custom_edit_url:null},s=void 0,o={unversionedId:"interfaces/headstartwp_core.react.useAppSettingsResponse",id:"interfaces/headstartwp_core.react.useAppSettingsResponse",title:"Interface: useAppSettingsResponse",description:"@headstartwp/core.react.useAppSettingsResponse",source:"@site/docs/interfaces/headstartwp_core.react.useAppSettingsResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.useAppSettingsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.useAppSettingsResponse",title:"Interface: useAppSettingsResponse",sidebar_label:"@headstartwp/core.react.useAppSettingsResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.YoutubeLiteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps"},next:{title:"@headstartwp/core.react.useFetchOptions",permalink:"/docs/api/interfaces/headstartwp_core.react.useFetchOptions"}},i={},c=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"mutate",id:"mutate",level:3},{value:"Defined in",id:"defined-in-4",level:4}],l={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},l,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".useAppSettingsResponse"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"useAppSettingsResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"T")),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetchAppSettings.ts#L9"},"packages/core/src/react/hooks/useFetchAppSettings.ts:9")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"mutate"},"mutate"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"mutate"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"KeyedMutator"),"<",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.FetchResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"FetchResponse")),"<",(0,n.kt)("inlineCode",{parentName:"p"},"T"),">",">"),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetchAppSettings.ts#L10"},"packages/core/src/react/hooks/useFetchAppSettings.ts:10")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/eb775807.c8420717.js b/assets/js/eb775807.c8420717.js deleted file mode 100644 index 16b07de86..000000000 --- a/assets/js/eb775807.c8420717.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8743],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>k});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function p(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var p=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var i=a.createContext({}),c=function(e){var t=a.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(i.Provider,{value:t},e.children)},l="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,p=e.originalType,i=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),l=c(r),h=n,k=l["".concat(i,".").concat(h)]||l[h]||u[h]||p;return r?a.createElement(k,o(o({ref:t},d),{},{components:r})):a.createElement(k,o({ref:t},d))}));function k(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var p=r.length,o=new Array(p);o[0]=h;var s={};for(var i in t)hasOwnProperty.call(t,i)&&(s[i]=t[i]);s.originalType=e,s[l]="string"==typeof e?e:n,o[1]=s;for(var c=2;c{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>o,default:()=>l,frontMatter:()=>p,metadata:()=>s,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const p={id:"headstartwp_core.react.useAppSettingsResponse",title:"Interface: useAppSettingsResponse",sidebar_label:"@headstartwp/core.react.useAppSettingsResponse",custom_edit_url:null},o=void 0,s={unversionedId:"interfaces/headstartwp_core.react.useAppSettingsResponse",id:"interfaces/headstartwp_core.react.useAppSettingsResponse",title:"Interface: useAppSettingsResponse",description:"@headstartwp/core.react.useAppSettingsResponse",source:"@site/docs/interfaces/headstartwp_core.react.useAppSettingsResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.useAppSettingsResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.useAppSettingsResponse",title:"Interface: useAppSettingsResponse",sidebar_label:"@headstartwp/core.react.useAppSettingsResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.YoutubeLiteBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps"},next:{title:"@headstartwp/core.react.useFetchOptions",permalink:"/docs/api/interfaces/headstartwp_core.react.useFetchOptions"}},i={},c=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],d={toc:c};function l(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".useAppSettingsResponse"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.AppEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"AppEntity")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"useAppSettingsResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"T")),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/useFetchAppSettings.ts#L8"},"packages/core/src/react/hooks/useFetchAppSettings.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")))}l.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ecbd967a.4faf63f8.js b/assets/js/ecbd967a.c7ef2bd6.js similarity index 96% rename from assets/js/ecbd967a.4faf63f8.js rename to assets/js/ecbd967a.c7ef2bd6.js index ffe98f590..53e1f24c7 100644 --- a/assets/js/ecbd967a.4faf63f8.js +++ b/assets/js/ecbd967a.c7ef2bd6.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6307],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>m});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var l=n.createContext({}),u=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},d=function(e){var t=u(e.components);return n.createElement(l.Provider,{value:t},e.children)},s="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,l=e.parentName,d=c(e,["components","mdxType","originalType","parentName"]),s=u(r),f=o,m=s["".concat(l,".").concat(f)]||s[f]||p[f]||a;return r?n.createElement(m,i(i({ref:t},d),{},{components:r})):n.createElement(m,i({ref:t},d))}));function m(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,i=new Array(a);i[0]=f;var c={};for(var l in t)hasOwnProperty.call(t,l)&&(c[l]=t[l]);c.originalType=e,c[s]="string"==typeof e?e:o,i[1]=c;for(var u=2;u{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>s,frontMatter:()=>a,metadata:()=>c,toc:()=>u});var n=r(7462),o=(r(7294),r(3905));const a={sidebar_position:0,sidebar_label:"Introduction"},i="Introduction",c={unversionedId:"index",id:"index",title:"Introduction",description:"Welcome to HeadstartWP documentation site! If you are new, we highly recommend reading all the way through Getting Started first.",source:"@site/documentation/index.md",sourceDirName:".",slug:"/",permalink:"/docs/learn/",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/index.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",sidebarPosition:0,frontMatter:{sidebar_position:0,sidebar_label:"Introduction"},sidebar:"tutorialSidebar",next:{title:"Quick Setup",permalink:"/docs/learn/getting-started/quick-setup"}},l={},u=[],d={toc:u};function s(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"introduction"},"Introduction"),(0,o.kt)("p",null,"Welcome to HeadstartWP documentation site! If you are new, we highly recommend reading all the way through ",(0,o.kt)("a",{parentName:"p",href:"/learn/getting-started/quick-setup/"},"Getting Started")," first."))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[6307],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>m});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var l=n.createContext({}),u=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},d=function(e){var t=u(e.components);return n.createElement(l.Provider,{value:t},e.children)},s="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,l=e.parentName,d=c(e,["components","mdxType","originalType","parentName"]),s=u(r),f=o,m=s["".concat(l,".").concat(f)]||s[f]||p[f]||a;return r?n.createElement(m,i(i({ref:t},d),{},{components:r})):n.createElement(m,i({ref:t},d))}));function m(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,i=new Array(a);i[0]=f;var c={};for(var l in t)hasOwnProperty.call(t,l)&&(c[l]=t[l]);c.originalType=e,c[s]="string"==typeof e?e:o,i[1]=c;for(var u=2;u{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>s,frontMatter:()=>a,metadata:()=>c,toc:()=>u});var n=r(7462),o=(r(7294),r(3905));const a={sidebar_position:0,sidebar_label:"Introduction"},i="Introduction",c={unversionedId:"index",id:"index",title:"Introduction",description:"Welcome to HeadstartWP documentation site! If you are new, we highly recommend reading all the way through Getting Started first.",source:"@site/documentation/index.md",sourceDirName:".",slug:"/",permalink:"/docs/learn/",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/index.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",sidebarPosition:0,frontMatter:{sidebar_position:0,sidebar_label:"Introduction"},sidebar:"tutorialSidebar",next:{title:"Quick Setup",permalink:"/docs/learn/getting-started/quick-setup"}},l={},u=[],d={toc:u};function s(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"introduction"},"Introduction"),(0,o.kt)("p",null,"Welcome to HeadstartWP documentation site! If you are new, we highly recommend reading all the way through ",(0,o.kt)("a",{parentName:"p",href:"/learn/getting-started/quick-setup/"},"Getting Started")," first."))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/ef311a1f.3ee92c6b.js b/assets/js/ef311a1f.3731d6d3.js similarity index 96% rename from assets/js/ef311a1f.3ee92c6b.js rename to assets/js/ef311a1f.3731d6d3.js index 37a396e3a..095ec2b19 100644 --- a/assets/js/ef311a1f.3ee92c6b.js +++ b/assets/js/ef311a1f.3731d6d3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5278],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function s(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),l=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},d=function(e){var t=l(e.components);return a.createElement(p.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,s=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),c=l(r),u=n,h=c["".concat(p,".").concat(u)]||c[u]||k[u]||s;return r?a.createElement(h,o(o({ref:t},d),{},{components:r})):a.createElement(h,o({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var s=r.length,o=new Array(s);o[0]=u;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[c]="string"==typeof e?e:n,o[1]=i;for(var l=2;l{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>c,frontMatter:()=>s,metadata:()=>i,toc:()=>l});var a=r(7462),n=(r(7294),r(3905));const s={id:"headstartwp_core.react.usePostOrPostResponse",title:"Interface: usePostOrPostResponse",sidebar_label:"@headstartwp/core.react.usePostOrPostResponse",custom_edit_url:null},o=void 0,i={unversionedId:"interfaces/headstartwp_core.react.usePostOrPostResponse",id:"interfaces/headstartwp_core.react.usePostOrPostResponse",title:"Interface: usePostOrPostResponse",description:"@headstartwp/core.react.usePostOrPostResponse",source:"@site/docs/interfaces/headstartwp_core.react.usePostOrPostResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.usePostOrPostResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.usePostOrPostResponse",title:"Interface: usePostOrPostResponse",sidebar_label:"@headstartwp/core.react.usePostOrPostResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.useMenuResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse"},next:{title:"@headstartwp/core.react.usePostResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostResponse"}},p={},l=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isArchive",id:"isarchive",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"isSingle",id:"issingle",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-5",level:4}],d={toc:l};function c(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".usePostOrPostResponse"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"usePostOrPostResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"post?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"posts?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]")))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/useFetchPostOrPosts.ts#L15"},"packages/core/src/react/hooks/useFetchPostOrPosts.ts:15")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"isarchive"},"isArchive"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isArchive"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/useFetchPostOrPosts.ts#L17"},"packages/core/src/react/hooks/useFetchPostOrPosts.ts:17")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"issingle"},"isSingle"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isSingle"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/useFetchPostOrPosts.ts#L16"},"packages/core/src/react/hooks/useFetchPostOrPosts.ts:16")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5278],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function s(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function o(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),l=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):o(o({},t),e)),r},d=function(e){var t=l(e.components);return a.createElement(p.Provider,{value:t},e.children)},c="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,s=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),c=l(r),u=n,h=c["".concat(p,".").concat(u)]||c[u]||k[u]||s;return r?a.createElement(h,o(o({ref:t},d),{},{components:r})):a.createElement(h,o({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var s=r.length,o=new Array(s);o[0]=u;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[c]="string"==typeof e?e:n,o[1]=i;for(var l=2;l{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>o,default:()=>c,frontMatter:()=>s,metadata:()=>i,toc:()=>l});var a=r(7462),n=(r(7294),r(3905));const s={id:"headstartwp_core.react.usePostOrPostResponse",title:"Interface: usePostOrPostResponse",sidebar_label:"@headstartwp/core.react.usePostOrPostResponse",custom_edit_url:null},o=void 0,i={unversionedId:"interfaces/headstartwp_core.react.usePostOrPostResponse",id:"interfaces/headstartwp_core.react.usePostOrPostResponse",title:"Interface: usePostOrPostResponse",description:"@headstartwp/core.react.usePostOrPostResponse",source:"@site/docs/interfaces/headstartwp_core.react.usePostOrPostResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.usePostOrPostResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.usePostOrPostResponse",title:"Interface: usePostOrPostResponse",sidebar_label:"@headstartwp/core.react.usePostOrPostResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.useMenuResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse"},next:{title:"@headstartwp/core.react.usePostResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostResponse"}},p={},l=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isArchive",id:"isarchive",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"isSingle",id:"issingle",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-5",level:4}],d={toc:l};function c(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".usePostOrPostResponse"),(0,n.kt)("h2",{id:"type-parameters"},"Type parameters"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T")),(0,n.kt)("td",{parentName:"tr",align:"left"},"extends ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity"))," = ",(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.PostEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"PostEntity")))))),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"usePostOrPostResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"post?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"posts?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"T"),"[]")))),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetchPostOrPosts.ts#L15"},"packages/core/src/react/hooks/useFetchPostOrPosts.ts:15")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"isarchive"},"isArchive"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isArchive"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetchPostOrPosts.ts#L17"},"packages/core/src/react/hooks/useFetchPostOrPosts.ts:17")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"issingle"},"isSingle"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isSingle"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetchPostOrPosts.ts#L16"},"packages/core/src/react/hooks/useFetchPostOrPosts.ts:16")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/f1627269.b01cd5aa.js b/assets/js/f1627269.3e3ec340.js similarity index 97% rename from assets/js/f1627269.b01cd5aa.js rename to assets/js/f1627269.3e3ec340.js index 94f65dab5..f6830f585 100644 --- a/assets/js/f1627269.b01cd5aa.js +++ b/assets/js/f1627269.3e3ec340.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5653],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>f});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},c=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},g=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,s=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),d=p(n),g=a,f=d["".concat(s,".").concat(g)]||d[g]||u[g]||o;return n?r.createElement(f,l(l({ref:t},c),{},{components:n})):r.createElement(f,l({ref:t},c))}));function f(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,l=new Array(o);l[0]=g;var i={};for(var s in t)hasOwnProperty.call(t,s)&&(i[s]=t[s]);i.originalType=e,i[d]="string"==typeof e?e:a,l[1]=i;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var r=n(7462),a=(n(7294),n(3905));const o={slug:"/wordpress-integration/polylang"},l="Polylang Integration",i={unversionedId:"WordPress Integration/polylang",id:"WordPress Integration/polylang",title:"Polylang Integration",description:"Polylang Pro is required since only Polylang Pro offers the REST API integration.",source:"@site/documentation/06-WordPress Integration/polylang.md",sourceDirName:"06-WordPress Integration",slug:"/wordpress-integration/polylang",permalink:"/docs/learn/wordpress-integration/polylang",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/06-WordPress Integration/polylang.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",frontMatter:{slug:"/wordpress-integration/polylang"},sidebar:"tutorialSidebar",previous:{title:"Gutenberg",permalink:"/docs/learn/wordpress-integration/gutenberg"},next:{title:"A/B Test SPA vs MPA navigation",permalink:"/docs/learn/Guides/ab-test-link"}},s={},p=[],c={toc:p};function d(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"polylang-integration"},"Polylang Integration"),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"Polylang Pro is required since only Polylang Pro offers the ",(0,a.kt)("a",{parentName:"p",href:"https://polylang.pro/doc/rest-api/"},"REST API integration"),".")),(0,a.kt)("p",null,"It is possible to integrate with Polylang by enabling the integration in ",(0,a.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," and adding the supported locales to ",(0,a.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/advanced-features/i18n-routing"},"Next.js config"),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"module.exports = {\n // other settings\n integrations: {\n yoastSEO: {\n enable: true,\n },\n polylang: {\n enable: true\n },\n },\n};\n")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="next.config.js"',title:'"next.config.js"'},"module.exports = {\n i18n: {\n // These are all the locales you want to support in\n // your application\n locales: ['en', 'fr', 'nl'],\n // This is the default locale you want to be used when visiting\n // a non-locale prefixed path e.g. `/hello`\n defaultLocale: 'en',\n }\n};\n")),(0,a.kt)("admonition",{type:"info"},(0,a.kt)("p",{parentName:"admonition"},"You need to make sure that the locales set in Polylang matches the locales set in Next.js config.")),(0,a.kt)("p",null,"Enabling this integration will automatically add the ",(0,a.kt)("inlineCode",{parentName:"p"},"lang")," attribute to all REST API calls made to WordPres (when using the data-fetching layer provided by the framework). The ",(0,a.kt)("inlineCode",{parentName:"p"},"lang")," attribute will be set based on the current Next.js locale (",(0,a.kt)("inlineCode",{parentName:"p"},"context.locale")," or ",(0,a.kt)("inlineCode",{parentName:"p"},"context.defaultLocale"),")."))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5653],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>f});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},c=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},g=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,s=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),d=p(n),g=a,f=d["".concat(s,".").concat(g)]||d[g]||u[g]||o;return n?r.createElement(f,l(l({ref:t},c),{},{components:n})):r.createElement(f,l({ref:t},c))}));function f(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,l=new Array(o);l[0]=g;var i={};for(var s in t)hasOwnProperty.call(t,s)&&(i[s]=t[s]);i.originalType=e,i[d]="string"==typeof e?e:a,l[1]=i;for(var p=2;p{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var r=n(7462),a=(n(7294),n(3905));const o={slug:"/wordpress-integration/polylang"},l="Polylang Integration",i={unversionedId:"WordPress Integration/polylang",id:"WordPress Integration/polylang",title:"Polylang Integration",description:"Polylang Pro is required since only Polylang Pro offers the REST API integration.",source:"@site/documentation/06-WordPress Integration/polylang.md",sourceDirName:"06-WordPress Integration",slug:"/wordpress-integration/polylang",permalink:"/docs/learn/wordpress-integration/polylang",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/06-WordPress Integration/polylang.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",frontMatter:{slug:"/wordpress-integration/polylang"},sidebar:"tutorialSidebar",previous:{title:"Gutenberg",permalink:"/docs/learn/wordpress-integration/gutenberg"},next:{title:"A/B Test SPA vs MPA navigation",permalink:"/docs/learn/Guides/ab-test-link"}},s={},p=[],c={toc:p};function d(e){let{components:t,...n}=e;return(0,a.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"polylang-integration"},"Polylang Integration"),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"Polylang Pro is required since only Polylang Pro offers the ",(0,a.kt)("a",{parentName:"p",href:"https://polylang.pro/doc/rest-api/"},"REST API integration"),".")),(0,a.kt)("p",null,"It is possible to integrate with Polylang by enabling the integration in ",(0,a.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," and adding the supported locales to ",(0,a.kt)("a",{parentName:"p",href:"https://nextjs.org/docs/advanced-features/i18n-routing"},"Next.js config"),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"module.exports = {\n // other settings\n integrations: {\n yoastSEO: {\n enable: true,\n },\n polylang: {\n enable: true\n },\n },\n};\n")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="next.config.js"',title:'"next.config.js"'},"module.exports = {\n i18n: {\n // These are all the locales you want to support in\n // your application\n locales: ['en', 'fr', 'nl'],\n // This is the default locale you want to be used when visiting\n // a non-locale prefixed path e.g. `/hello`\n defaultLocale: 'en',\n }\n};\n")),(0,a.kt)("admonition",{type:"info"},(0,a.kt)("p",{parentName:"admonition"},"You need to make sure that the locales set in Polylang matches the locales set in Next.js config.")),(0,a.kt)("p",null,"Enabling this integration will automatically add the ",(0,a.kt)("inlineCode",{parentName:"p"},"lang")," attribute to all REST API calls made to WordPres (when using the data-fetching layer provided by the framework). The ",(0,a.kt)("inlineCode",{parentName:"p"},"lang")," attribute will be set based on the current Next.js locale (",(0,a.kt)("inlineCode",{parentName:"p"},"context.locale")," or ",(0,a.kt)("inlineCode",{parentName:"p"},"context.defaultLocale"),")."))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/f2d13ce1.7a2a7e7b.js b/assets/js/f2d13ce1.33392f1c.js similarity index 90% rename from assets/js/f2d13ce1.7a2a7e7b.js rename to assets/js/f2d13ce1.33392f1c.js index 88af493ed..5371de05b 100644 --- a/assets/js/f2d13ce1.7a2a7e7b.js +++ b/assets/js/f2d13ce1.33392f1c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5355],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),s=c(r),m=n,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||i;return r?a.createElement(h,l(l({ref:t},d),{},{components:r})):a.createElement(h,l({ref:t},d))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[s]="string"==typeof e?e:n,l[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.ColumnsBlockProps",title:"Interface: ColumnsBlockProps",sidebar_label:"@headstartwp/core.react.ColumnsBlockProps",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.ColumnsBlockProps",id:"interfaces/headstartwp_core.react.ColumnsBlockProps",title:"Interface: ColumnsBlockProps",description:"@headstartwp/core.react.ColumnsBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.ColumnsBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ColumnsBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ColumnsBlockProps",title:"Interface: ColumnsBlockProps",sidebar_label:"@headstartwp/core.react.ColumnsBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ColumnBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps"},next:{title:"@headstartwp/core.react.CoverBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],d={toc:c};function s(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ColumnsBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ColumnsBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5355],{3905:(e,t,r)=>{r.d(t,{Zo:()=>s,kt:()=>h});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},s=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},d="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,p=e.parentName,s=o(e,["components","mdxType","originalType","parentName"]),d=c(r),m=n,h=d["".concat(p,".").concat(m)]||d[m]||k[m]||i;return r?a.createElement(h,l(l({ref:t},s),{},{components:r})):a.createElement(h,l({ref:t},s))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=m;var o={};for(var p in t)hasOwnProperty.call(t,p)&&(o[p]=t[p]);o.originalType=e,o[d]="string"==typeof e?e:n,l[1]=o;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const i={id:"headstartwp_core.react.ColumnsBlockProps",title:"Interface: ColumnsBlockProps",sidebar_label:"@headstartwp/core.react.ColumnsBlockProps",custom_edit_url:null},l=void 0,o={unversionedId:"interfaces/headstartwp_core.react.ColumnsBlockProps",id:"interfaces/headstartwp_core.react.ColumnsBlockProps",title:"Interface: ColumnsBlockProps",description:"@headstartwp/core.react.ColumnsBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.ColumnsBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.ColumnsBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.ColumnsBlockProps",title:"Interface: ColumnsBlockProps",sidebar_label:"@headstartwp/core.react.ColumnsBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.ColumnBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps"},next:{title:"@headstartwp/core.react.CoverBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}],s={toc:c};function d(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".ColumnsBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"ColumnsBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/f3283cd4.db06c505.js b/assets/js/f3283cd4.b707eec8.js similarity index 99% rename from assets/js/f3283cd4.db06c505.js rename to assets/js/f3283cd4.b707eec8.js index 779361b66..14e6cc212 100644 --- a/assets/js/f3283cd4.db06c505.js +++ b/assets/js/f3283cd4.b707eec8.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8604],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>h});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),l=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},d=function(e){var t=l(e.components);return a.createElement(p.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},g=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),c=l(n),g=r,h=c["".concat(p,".").concat(g)]||c[g]||u[g]||o;return n?a.createElement(h,s(s({ref:t},d),{},{components:n})):a.createElement(h,s({ref:t},d))}));function h(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,s=new Array(o);s[0]=g;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[c]="string"==typeof e?e:r,s[1]=i;for(var l=2;l{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>c,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var a=n(7462),r=(n(7294),n(3905));const o={slug:"/getting-started/setting-up-manually",sidebar_position:1},s="Setting up the framework from scratch",i={unversionedId:"Getting Started/setting-up-manually",id:"Getting Started/setting-up-manually",title:"Setting up the framework from scratch",description:"The recommended way to get started with the framework is by installing the official starter project. See Quick Setup for more information.",source:"@site/documentation/01-Getting Started/setting-up-manually.md",sourceDirName:"01-Getting Started",slug:"/getting-started/setting-up-manually",permalink:"/docs/learn/getting-started/setting-up-manually",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/01-Getting Started/setting-up-manually.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",sidebarPosition:1,frontMatter:{slug:"/getting-started/setting-up-manually",sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"Quick Setup",permalink:"/docs/learn/getting-started/quick-setup"},next:{title:"Configuring the Framework",permalink:"/docs/learn/getting-started/headless-config"}},p={},l=[{value:"Bootstrap the Next.js project",id:"bootstrap-the-nextjs-project",level:2},{value:"headstartwp.config.js",id:"headstartwpconfigjs",level:3},{value:"Env variables",id:"env-variables",level:3},{value:"next.config.js",id:"nextconfigjs",level:3},{value:"pages/_app.js",id:"pages_appjs",level:3},{value:"Setting up the preview endpoint",id:"setting-up-the-preview-endpoint",level:3},{value:"Setting up the revalidate endpoint",id:"setting-up-the-revalidate-endpoint",level:3},{value:"Creating your first route",id:"creating-your-first-route",level:3},{value:"Add SSR/SSG",id:"add-ssrssg",level:3}],d={toc:l};function c(e){let{components:t,...o}=e;return(0,r.kt)("wrapper",(0,a.Z)({},d,o,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"setting-up-the-framework-from-scratch"},"Setting up the framework from scratch"),(0,r.kt)("p",null,"The recommended way to get started with the framework is by installing the official starter project. See ",(0,r.kt)("a",{parentName:"p",href:"/learn/getting-started/quick-setup/"},"Quick Setup")," for more information."),(0,r.kt)("p",null,"This guide will help you set up the framework in a clean Next.js project."),(0,r.kt)("h2",{id:"bootstrap-the-nextjs-project"},"Bootstrap the Next.js project"),(0,r.kt)("p",null,"Start by bootstrapping your next.js project."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},"npx create-next-app@latest --use-npm\n")),(0,r.kt)("p",null,"and install the following packages"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"npm install --save @headstartwp/core @headstartwp/next\n")),(0,r.kt)("h3",{id:"headstartwpconfigjs"},"headstartwp.config.js"),(0,r.kt)("p",null,"Create a ",(0,r.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," file at the root of your Next.js project."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"/**\n * Headless Config\n *\n * @type {import('@headstartwp/core').HeadlessConfig}\n */\nmodule.exports = {\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,\n\n useWordPressPlugin: true,\n};\n")),(0,r.kt)("h3",{id:"env-variables"},"Env variables"),(0,r.kt)("p",null,"Then create a ",(0,r.kt)("inlineCode",{parentName:"p"},".env")," (or ",(0,r.kt)("inlineCode",{parentName:"p"},".env.local"),") with the following contents:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"NEXT_PUBLIC_HEADLESS_WP_URL=https://my-wordpress.test\n")),(0,r.kt)("p",null,"You can call the env variable anything you want, just make sure to update ",(0,r.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," accordingly."),(0,r.kt)("p",null,"If you're developing locally and your WordPress instance uses https but does not have a valid cert, add ",(0,r.kt)("inlineCode",{parentName:"p"},"NODE_TLS_REJECT_UNAUTHORIZED=0")," to your env variables."),(0,r.kt)("h3",{id:"nextconfigjs"},"next.config.js"),(0,r.kt)("p",null,"Create a ",(0,r.kt)("inlineCode",{parentName:"p"},"next.config.js")," file with the following contents:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=next.config.js",title:"next.config.js"},"const { withHeadstartWPConfig } = require('@headstartwp/next/config');\n\n/**\n * Update whatever you need within the nextConfig object.\n *\n * @type {import('next').NextConfig}\n */\nconst nextConfig = {};\n\nmodule.exports = withHeadstartWPConfig(nextConfig);\n")),(0,r.kt)("h3",{id:"pages_appjs"},"pages/_app.js"),(0,r.kt)("p",null,"Create a custom ",(0,r.kt)("inlineCode",{parentName:"p"},"_app.js")," to wrap the application with ",(0,r.kt)("inlineCode",{parentName:"p"},"HeadlessApp")," component."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/pages/_app.js",title:"src/pages/_app.js"},"import { HeadlessApp } from '@headstartwp/next';\nimport Link from 'next/link';\nimport Router from 'next/router';\n\nimport '../styles.css';\n\nconst MyApp = ({ Component, pageProps }) => {\n // only HeadlessApp needs fallback and themeJson, so we remove them from the props we pass down to the pages\n\n // eslint-disable-next-line react/prop-types, no-unused-vars\n const { fallback = {}, themeJson = {}, ...props } = pageProps;\n\n return (\n \n \n \n );\n};\n\nexport default MyApp;\n")),(0,r.kt)("h3",{id:"setting-up-the-preview-endpoint"},"Setting up the preview endpoint"),(0,r.kt)("p",null,"The WordPress plugin expects the preview endpoint to be located at ",(0,r.kt)("inlineCode",{parentName:"p"},"/api/preview"),"."),(0,r.kt)("p",null,"To enable support for previews, create a ",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/api/preview.js")," with the following contents:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/pages/api/preview.js",title:"src/pages/api/preview.js"},"import { previewHandler } from '@headstartwp/next';\n\n/**\n * The Preview endpoint just needs to proxy the default preview handler\n *\n * @param {*} req Next.js request object\n * @param {*} res Next.js response object\n *\n * @returns\n */\nexport default async function handler(req, res) {\n return previewHandler(req, res);\n}\n")),(0,r.kt)("h3",{id:"setting-up-the-revalidate-endpoint"},"Setting up the revalidate endpoint"),(0,r.kt)("p",null,"The framework supports ISR revalidation triggered by WordPress. To enable ISR revalidate, make sure you have the WordPress plugin enabled and activate the option in WordPress settings."),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"ISR Option",src:n(2652).Z,width:"1830",height:"342"})),(0,r.kt)("p",null,"Then add the ",(0,r.kt)("inlineCode",{parentName:"p"},"revalidateHandler")," to ",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/api/revalidate.js")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/pages/api/revalidate.js",title:"src/pages/api/revalidate.js"},"import { revalidateHandler } from '@headstartwp/next';\n\n/**\n * The revalidate endpoint just needs to proxy the default revalidate handler\n *\n * @param {*} req Next.js request object\n * @param {*} res Next.js response object\n *\n * @returns\n */\nexport default async function handler(req, res) {\n return revalidateHandler(req, res);\n}\n")),(0,r.kt)("h3",{id:"creating-your-first-route"},"Creating your first route"),(0,r.kt)("p",null,"To make sure everything is working as expected create a catch-all route called ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/[...path].js"),". This route will be responsible for rendering single post and pages."),(0,r.kt)("p",null,"By creating a ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js")," route, the framework will automatically detect and extract URL parameters from the ",(0,r.kt)("inlineCode",{parentName:"p"},"path")," argument."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/pages/[...path].js",title:"src/pages/[...path].js"},"import {\n usePost,\n fetchHookData,\n addHookData,\n handleError,\n usePosts\n} from '@headstartwp/next';\nimport { BlocksRenderer } from '@headstartwp/core/react';\n\nconst params = { postType: ['post', 'page' ] };\n\nconst SinglePostsPage = () => {\n const { loading, error, data } = usePost(params);\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n

{data.post.title.rendered}

\n \n
\n );\n};\n\nexport default SinglePostsPage;\n")),(0,r.kt)("p",null,"Then, visit any single post or page, e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"http://localhost:3000/hello-world")," and you should see both the title and the content of that post/page."),(0,r.kt)("p",null,"Date URLs will also work: e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"http://localhost:3000/2022/10/2/hello-world")),(0,r.kt)("h3",{id:"add-ssrssg"},"Add SSR/SSG"),(0,r.kt)("p",null,"With the example above, you might have noticed that the data is only being fetched on the client. You must use one of the Next.js data fetching methods to enable SSR/SSG."),(0,r.kt)("p",null,"Add this to the ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/[...path].js")," file"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/[...path].js"',title:'"src/pages/[...path].js"'},"// or export async function getServerSideProps(context)\nexport async function getStaticProps(context) {\n try {\n // make sure to pass the same params to fetchHookData and usePost\n const usePostData = await fetchHookData(usePost.fetcher(), context, { params });\n\n return addHookData([usePostData], {});\n } catch (e) {\n return handleError(e, context);\n }\n}\n")),(0,r.kt)("p",null,"Then refresh the page and voil\xe1! Data is now being fetched on the server."))}c.isMDXComponent=!0},2652:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/revalidate-option-2ea5f7ed5040a6a9df3edd4ef64315e2.png"}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8604],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>h});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),l=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},d=function(e){var t=l(e.components);return a.createElement(p.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},g=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),c=l(n),g=r,h=c["".concat(p,".").concat(g)]||c[g]||u[g]||o;return n?a.createElement(h,s(s({ref:t},d),{},{components:n})):a.createElement(h,s({ref:t},d))}));function h(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,s=new Array(o);s[0]=g;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[c]="string"==typeof e?e:r,s[1]=i;for(var l=2;l{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>c,frontMatter:()=>o,metadata:()=>i,toc:()=>l});var a=n(7462),r=(n(7294),n(3905));const o={slug:"/getting-started/setting-up-manually",sidebar_position:1},s="Setting up the framework from scratch",i={unversionedId:"Getting Started/setting-up-manually",id:"Getting Started/setting-up-manually",title:"Setting up the framework from scratch",description:"The recommended way to get started with the framework is by installing the official starter project. See Quick Setup for more information.",source:"@site/documentation/01-Getting Started/setting-up-manually.md",sourceDirName:"01-Getting Started",slug:"/getting-started/setting-up-manually",permalink:"/docs/learn/getting-started/setting-up-manually",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/01-Getting Started/setting-up-manually.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",sidebarPosition:1,frontMatter:{slug:"/getting-started/setting-up-manually",sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"Quick Setup",permalink:"/docs/learn/getting-started/quick-setup"},next:{title:"Configuring the Framework",permalink:"/docs/learn/getting-started/headless-config"}},p={},l=[{value:"Bootstrap the Next.js project",id:"bootstrap-the-nextjs-project",level:2},{value:"headstartwp.config.js",id:"headstartwpconfigjs",level:3},{value:"Env variables",id:"env-variables",level:3},{value:"next.config.js",id:"nextconfigjs",level:3},{value:"pages/_app.js",id:"pages_appjs",level:3},{value:"Setting up the preview endpoint",id:"setting-up-the-preview-endpoint",level:3},{value:"Setting up the revalidate endpoint",id:"setting-up-the-revalidate-endpoint",level:3},{value:"Creating your first route",id:"creating-your-first-route",level:3},{value:"Add SSR/SSG",id:"add-ssrssg",level:3}],d={toc:l};function c(e){let{components:t,...o}=e;return(0,r.kt)("wrapper",(0,a.Z)({},d,o,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"setting-up-the-framework-from-scratch"},"Setting up the framework from scratch"),(0,r.kt)("p",null,"The recommended way to get started with the framework is by installing the official starter project. See ",(0,r.kt)("a",{parentName:"p",href:"/learn/getting-started/quick-setup/"},"Quick Setup")," for more information."),(0,r.kt)("p",null,"This guide will help you set up the framework in a clean Next.js project."),(0,r.kt)("h2",{id:"bootstrap-the-nextjs-project"},"Bootstrap the Next.js project"),(0,r.kt)("p",null,"Start by bootstrapping your next.js project."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},"npx create-next-app@latest --use-npm\n")),(0,r.kt)("p",null,"and install the following packages"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"npm install --save @headstartwp/core @headstartwp/next\n")),(0,r.kt)("h3",{id:"headstartwpconfigjs"},"headstartwp.config.js"),(0,r.kt)("p",null,"Create a ",(0,r.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," file at the root of your Next.js project."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="headstartwp.config.js"',title:'"headstartwp.config.js"'},"/**\n * Headless Config\n *\n * @type {import('@headstartwp/core').HeadlessConfig}\n */\nmodule.exports = {\n sourceUrl: process.env.NEXT_PUBLIC_HEADLESS_WP_URL,\n\n useWordPressPlugin: true,\n};\n")),(0,r.kt)("h3",{id:"env-variables"},"Env variables"),(0,r.kt)("p",null,"Then create a ",(0,r.kt)("inlineCode",{parentName:"p"},".env")," (or ",(0,r.kt)("inlineCode",{parentName:"p"},".env.local"),") with the following contents:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"NEXT_PUBLIC_HEADLESS_WP_URL=https://my-wordpress.test\n")),(0,r.kt)("p",null,"You can call the env variable anything you want, just make sure to update ",(0,r.kt)("inlineCode",{parentName:"p"},"headstartwp.config.js")," accordingly."),(0,r.kt)("p",null,"If you're developing locally and your WordPress instance uses https but does not have a valid cert, add ",(0,r.kt)("inlineCode",{parentName:"p"},"NODE_TLS_REJECT_UNAUTHORIZED=0")," to your env variables."),(0,r.kt)("h3",{id:"nextconfigjs"},"next.config.js"),(0,r.kt)("p",null,"Create a ",(0,r.kt)("inlineCode",{parentName:"p"},"next.config.js")," file with the following contents:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=next.config.js",title:"next.config.js"},"const { withHeadstartWPConfig } = require('@headstartwp/next/config');\n\n/**\n * Update whatever you need within the nextConfig object.\n *\n * @type {import('next').NextConfig}\n */\nconst nextConfig = {};\n\nmodule.exports = withHeadstartWPConfig(nextConfig);\n")),(0,r.kt)("h3",{id:"pages_appjs"},"pages/_app.js"),(0,r.kt)("p",null,"Create a custom ",(0,r.kt)("inlineCode",{parentName:"p"},"_app.js")," to wrap the application with ",(0,r.kt)("inlineCode",{parentName:"p"},"HeadlessApp")," component."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/pages/_app.js",title:"src/pages/_app.js"},"import { HeadlessApp } from '@headstartwp/next';\nimport Link from 'next/link';\nimport Router from 'next/router';\n\nimport '../styles.css';\n\nconst MyApp = ({ Component, pageProps }) => {\n // only HeadlessApp needs fallback and themeJson, so we remove them from the props we pass down to the pages\n\n // eslint-disable-next-line react/prop-types, no-unused-vars\n const { fallback = {}, themeJson = {}, ...props } = pageProps;\n\n return (\n \n \n \n );\n};\n\nexport default MyApp;\n")),(0,r.kt)("h3",{id:"setting-up-the-preview-endpoint"},"Setting up the preview endpoint"),(0,r.kt)("p",null,"The WordPress plugin expects the preview endpoint to be located at ",(0,r.kt)("inlineCode",{parentName:"p"},"/api/preview"),"."),(0,r.kt)("p",null,"To enable support for previews, create a ",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/api/preview.js")," with the following contents:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/pages/api/preview.js",title:"src/pages/api/preview.js"},"import { previewHandler } from '@headstartwp/next';\n\n/**\n * The Preview endpoint just needs to proxy the default preview handler\n *\n * @param {*} req Next.js request object\n * @param {*} res Next.js response object\n *\n * @returns\n */\nexport default async function handler(req, res) {\n return previewHandler(req, res);\n}\n")),(0,r.kt)("h3",{id:"setting-up-the-revalidate-endpoint"},"Setting up the revalidate endpoint"),(0,r.kt)("p",null,"The framework supports ISR revalidation triggered by WordPress. To enable ISR revalidate, make sure you have the WordPress plugin enabled and activate the option in WordPress settings."),(0,r.kt)("p",null,(0,r.kt)("img",{alt:"ISR Option",src:n(2652).Z,width:"1830",height:"342"})),(0,r.kt)("p",null,"Then add the ",(0,r.kt)("inlineCode",{parentName:"p"},"revalidateHandler")," to ",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/api/revalidate.js")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/pages/api/revalidate.js",title:"src/pages/api/revalidate.js"},"import { revalidateHandler } from '@headstartwp/next';\n\n/**\n * The revalidate endpoint just needs to proxy the default revalidate handler\n *\n * @param {*} req Next.js request object\n * @param {*} res Next.js response object\n *\n * @returns\n */\nexport default async function handler(req, res) {\n return revalidateHandler(req, res);\n}\n")),(0,r.kt)("h3",{id:"creating-your-first-route"},"Creating your first route"),(0,r.kt)("p",null,"To make sure everything is working as expected create a catch-all route called ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/[...path].js"),". This route will be responsible for rendering single post and pages."),(0,r.kt)("p",null,"By creating a ",(0,r.kt)("inlineCode",{parentName:"p"},"[...path].js")," route, the framework will automatically detect and extract URL parameters from the ",(0,r.kt)("inlineCode",{parentName:"p"},"path")," argument."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:"title=src/pages/[...path].js",title:"src/pages/[...path].js"},"import {\n usePost,\n fetchHookData,\n addHookData,\n handleError,\n usePosts\n} from '@headstartwp/next';\nimport { BlocksRenderer } from '@headstartwp/core/react';\n\nconst params = { postType: ['post', 'page' ] };\n\nconst SinglePostsPage = () => {\n const { loading, error, data } = usePost(params);\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n return (\n
\n

{data.post.title.rendered}

\n \n
\n );\n};\n\nexport default SinglePostsPage;\n")),(0,r.kt)("p",null,"Then, visit any single post or page, e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"http://localhost:3000/hello-world")," and you should see both the title and the content of that post/page."),(0,r.kt)("p",null,"Date URLs will also work: e.g: ",(0,r.kt)("inlineCode",{parentName:"p"},"http://localhost:3000/2022/10/2/hello-world")),(0,r.kt)("h3",{id:"add-ssrssg"},"Add SSR/SSG"),(0,r.kt)("p",null,"With the example above, you might have noticed that the data is only being fetched on the client. You must use one of the Next.js data fetching methods to enable SSR/SSG."),(0,r.kt)("p",null,"Add this to the ",(0,r.kt)("inlineCode",{parentName:"p"},"pages/[...path].js")," file"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/[...path].js"',title:'"src/pages/[...path].js"'},"// or export async function getServerSideProps(context)\nexport async function getStaticProps(context) {\n try {\n // make sure to pass the same params to fetchHookData and usePost\n const usePostData = await fetchHookData(usePost.fetcher(), context, { params });\n\n return addHookData([usePostData], {});\n } catch (e) {\n return handleError(e, context);\n }\n}\n")),(0,r.kt)("p",null,"Then refresh the page and voil\xe1! Data is now being fetched on the server."))}c.isMDXComponent=!0},2652:(e,t,n)=>{n.d(t,{Z:()=>a});const a=n.p+"assets/images/revalidate-option-2ea5f7ed5040a6a9df3edd4ef64315e2.png"}}]); \ No newline at end of file diff --git a/assets/js/f3d95041.98a358e0.js b/assets/js/f3d95041.12289038.js similarity index 98% rename from assets/js/f3d95041.98a358e0.js rename to assets/js/f3d95041.12289038.js index e9b212c72..21b0d04c3 100644 --- a/assets/js/f3d95041.98a358e0.js +++ b/assets/js/f3d95041.12289038.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5405],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>h});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var i=n.createContext({}),c=function(e){var t=n.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},p=function(e){var t=c(e.components);return n.createElement(i.Provider,{value:t},e.children)},d="mdxType",_={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,i=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),d=c(r),u=a,h=d["".concat(i,".").concat(u)]||d[u]||_[u]||o;return r?n.createElement(h,l(l({ref:t},p),{},{components:r})):n.createElement(h,l({ref:t},p))}));function h(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,l=new Array(o);l[0]=u;var s={};for(var i in t)hasOwnProperty.call(t,i)&&(s[i]=t[i]);s.originalType=e,s[d]="string"==typeof e?e:a,l[1]=s;for(var c=2;c{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>l,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>c});var n=r(7462),a=(r(7294),r(3905));const o={slug:"/wordpress-integration/gutenberg"},l="Gutenberg",s={unversionedId:"WordPress Integration/gutenberg",id:"WordPress Integration/gutenberg",title:"Gutenberg",description:"The HeadstartWP Plugin enhances every block with two special attributes directly in the markup: data-wp-block-name and data-wp-block. The first holds the name of the block and the second holds all of the block attributes.",source:"@site/documentation/06-WordPress Integration/gutenberg.md",sourceDirName:"06-WordPress Integration",slug:"/wordpress-integration/gutenberg",permalink:"/docs/learn/wordpress-integration/gutenberg",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/06-WordPress Integration/gutenberg.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",frontMatter:{slug:"/wordpress-integration/gutenberg"},sidebar:"tutorialSidebar",previous:{title:"Feeds",permalink:"/docs/learn/wordpress-integration/feeds"},next:{title:"Polylang Integration",permalink:"/docs/learn/wordpress-integration/polylang"}},i={},c=[{value:"Available Filters",id:"available-filters",level:2},{value:"tenup_headless_wp_render_block_attrs",id:"tenup_headless_wp_render_block_attrs",level:3},{value:"tenup_headless_wp_render_blocks_attrs_serialized",id:"tenup_headless_wp_render_blocks_attrs_serialized",level:3},{value:"tenup_headless_wp_render_block_use_tag_processor",id:"tenup_headless_wp_render_block_use_tag_processor",level:3},{value:"tenup_headless_wp_render_block_markup",id:"tenup_headless_wp_render_block_markup",level:3},{value:"tenup_headless_wp_render_html_tag_processor_block_markup",id:"tenup_headless_wp_render_html_tag_processor_block_markup",level:3}],p={toc:c};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"gutenberg"},"Gutenberg"),(0,a.kt)("p",null,"The HeadstartWP Plugin enhances every block with two special attributes directly in the markup: ",(0,a.kt)("inlineCode",{parentName:"p"},"data-wp-block-name")," and ",(0,a.kt)("inlineCode",{parentName:"p"},"data-wp-block"),". The first holds the name of the block and the second holds all of the block attributes."),(0,a.kt)("p",null,"These data attributes can be used for matching blocks in ",(0,a.kt)("inlineCode",{parentName:"p"},"BlocksRenderer")," and for accessing block's attributes directly in your React component."),(0,a.kt)("h2",{id:"available-filters"},"Available Filters"),(0,a.kt)("p",null,"There are a few filters available that you can hook into."),(0,a.kt)("h3",{id:"tenup_headless_wp_render_block_attrs"},"tenup_headless_wp_render_block_attrs"),(0,a.kt)("p",null,"This filter allows you to filter the block attributes before serializing them into the markup. You can use this to include additional attributes that you might need on the front-end. For instance, you can add information for a post instead of just a post id to prevent making an extra HTTP request to get the data for a post."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-php"},"/**\n * Filter's out the block's attributes before serializing in the block markup.\n *\n * @param array $attrs The Block's Attributes\n * @param array $block The Block's schema\n * @param \\WP_Block $block_instance The block's instance\n */\n$block_attrs = apply_filters( \n 'tenup_headless_wp_render_block_attrs', \n $block_attrs, \n $block, \n $block_instance \n);\n")),(0,a.kt)("h3",{id:"tenup_headless_wp_render_blocks_attrs_serialized"},"tenup_headless_wp_render_blocks_attrs_serialized"),(0,a.kt)("p",null,"This filter is not as useful as the previous one but it allows you to filter the serialized attributes."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-php"},"/**\n * Filter's out the block's attributes after serialization\n *\n * @param string $encoded_attrs The serialized block's Attributes\n * @param array $attrs The Block's Attributes\n * @param array $block The Block's schema\n * @param \\WP_Block $block_instance The block's instance\n */\n$block_attrs_serialized = apply_filters(\n 'tenup_headless_wp_render_blocks_attrs_serialized',\n esc_attr( wp_json_encode( $block_attrs ) ),\n $block_attrs,\n $block,\n $block_instance\n);\n")),(0,a.kt)("h3",{id:"tenup_headless_wp_render_block_use_tag_processor"},"tenup_headless_wp_render_block_use_tag_processor"),(0,a.kt)("p",null,"HeadstartWP will use the DomDocument API for parsing and enhancing the block markup by default. Since 1.0.7, it is possible to opt into the new ",(0,a.kt)("inlineCode",{parentName:"p"},"WP_Html_Tag_Processor")," API via the ",(0,a.kt)("inlineCode",{parentName:"p"},"tenup_headless_wp_render_block_use_tag_processor"),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-php"},"add_filter( 'tenup_headless_wp_render_block_use_tag_processor', '__return_true' );\n")),(0,a.kt)("p",null,"In the next major release, usage of the DomDocument API will be removed in favor of ",(0,a.kt)("inlineCode",{parentName:"p"},"WP_Html_Tag_Processor")," since it's easier to use and a core API. For most users this should not change anything, both APIs should yield the same result and the deprecation of the DomDocument API is merely for simplicity."),(0,a.kt)("h3",{id:"tenup_headless_wp_render_block_markup"},"tenup_headless_wp_render_block_markup"),(0,a.kt)("p",null,"This filter is called after adding the data attributes but before returning the block's final markup. You can use this filter to perform any additional modifications to the block markup."),(0,a.kt)("p",null,"This filter is only called when using the DomDocument API (i.e - the filter ",(0,a.kt)("inlineCode",{parentName:"p"},"tenup_headless_wp_render_block_use_tag_processor")," returns false)."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-php"},"/**\n * Filter the block's DOMElement before rendering\n *\n * @param \\DOMElement $root_node\n * @param string $html The original block markup\n * @param array $block The Block's schema\n * @param \\WP_Block $block_instance The block's instance\n */\n$root_node = apply_filters( \n 'tenup_headless_wp_render_block_markup', \n $root_node, \n $html, \n $block, \n $block_instance\n);\n")),(0,a.kt)("h3",{id:"tenup_headless_wp_render_html_tag_processor_block_markup"},"tenup_headless_wp_render_html_tag_processor_block_markup"),(0,a.kt)("p",null,"This filter is called after adding the data attributes but before returning the block's final markup when the ",(0,a.kt)("inlineCode",{parentName:"p"},"WP_HTML_Tag_Processor")," API is being used. You can use this filter to perform any additional modifications to the block markup."),(0,a.kt)("p",null,"This filter is only called when using the WP_HTML_Tag_Processor API (i.e - the filter ",(0,a.kt)("inlineCode",{parentName:"p"},"tenup_headless_wp_render_block_use_tag_processor")," returns true)."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-php"},"/**\n * Filter the block's before rendering\n *\n * @param \\WP_HTML_Tag_Processor $doc\n * @param string $html The original block markup\n * @param array $block The Block's schema\n * @param \\WP_Block $block_instance The block's instance\n */\n$doc = apply_filters( \n 'tenup_headless_wp_render_html_tag_processor_block_markup', \n $doc, \n $html, \n $block, \n $block_instance\n);\n")))}d.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5405],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>h});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var i=n.createContext({}),c=function(e){var t=n.useContext(i),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},p=function(e){var t=c(e.components);return n.createElement(i.Provider,{value:t},e.children)},d="mdxType",_={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,i=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),d=c(r),u=a,h=d["".concat(i,".").concat(u)]||d[u]||_[u]||o;return r?n.createElement(h,l(l({ref:t},p),{},{components:r})):n.createElement(h,l({ref:t},p))}));function h(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,l=new Array(o);l[0]=u;var s={};for(var i in t)hasOwnProperty.call(t,i)&&(s[i]=t[i]);s.originalType=e,s[d]="string"==typeof e?e:a,l[1]=s;for(var c=2;c{r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>l,default:()=>d,frontMatter:()=>o,metadata:()=>s,toc:()=>c});var n=r(7462),a=(r(7294),r(3905));const o={slug:"/wordpress-integration/gutenberg"},l="Gutenberg",s={unversionedId:"WordPress Integration/gutenberg",id:"WordPress Integration/gutenberg",title:"Gutenberg",description:"The HeadstartWP Plugin enhances every block with two special attributes directly in the markup: data-wp-block-name and data-wp-block. The first holds the name of the block and the second holds all of the block attributes.",source:"@site/documentation/06-WordPress Integration/gutenberg.md",sourceDirName:"06-WordPress Integration",slug:"/wordpress-integration/gutenberg",permalink:"/docs/learn/wordpress-integration/gutenberg",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/06-WordPress Integration/gutenberg.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",frontMatter:{slug:"/wordpress-integration/gutenberg"},sidebar:"tutorialSidebar",previous:{title:"Feeds",permalink:"/docs/learn/wordpress-integration/feeds"},next:{title:"Polylang Integration",permalink:"/docs/learn/wordpress-integration/polylang"}},i={},c=[{value:"Available Filters",id:"available-filters",level:2},{value:"tenup_headless_wp_render_block_attrs",id:"tenup_headless_wp_render_block_attrs",level:3},{value:"tenup_headless_wp_render_blocks_attrs_serialized",id:"tenup_headless_wp_render_blocks_attrs_serialized",level:3},{value:"tenup_headless_wp_render_block_use_tag_processor",id:"tenup_headless_wp_render_block_use_tag_processor",level:3},{value:"tenup_headless_wp_render_block_markup",id:"tenup_headless_wp_render_block_markup",level:3},{value:"tenup_headless_wp_render_html_tag_processor_block_markup",id:"tenup_headless_wp_render_html_tag_processor_block_markup",level:3}],p={toc:c};function d(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"gutenberg"},"Gutenberg"),(0,a.kt)("p",null,"The HeadstartWP Plugin enhances every block with two special attributes directly in the markup: ",(0,a.kt)("inlineCode",{parentName:"p"},"data-wp-block-name")," and ",(0,a.kt)("inlineCode",{parentName:"p"},"data-wp-block"),". The first holds the name of the block and the second holds all of the block attributes."),(0,a.kt)("p",null,"These data attributes can be used for matching blocks in ",(0,a.kt)("inlineCode",{parentName:"p"},"BlocksRenderer")," and for accessing block's attributes directly in your React component."),(0,a.kt)("h2",{id:"available-filters"},"Available Filters"),(0,a.kt)("p",null,"There are a few filters available that you can hook into."),(0,a.kt)("h3",{id:"tenup_headless_wp_render_block_attrs"},"tenup_headless_wp_render_block_attrs"),(0,a.kt)("p",null,"This filter allows you to filter the block attributes before serializing them into the markup. You can use this to include additional attributes that you might need on the front-end. For instance, you can add information for a post instead of just a post id to prevent making an extra HTTP request to get the data for a post."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-php"},"/**\n * Filter's out the block's attributes before serializing in the block markup.\n *\n * @param array $attrs The Block's Attributes\n * @param array $block The Block's schema\n * @param \\WP_Block $block_instance The block's instance\n */\n$block_attrs = apply_filters( \n 'tenup_headless_wp_render_block_attrs', \n $block_attrs, \n $block, \n $block_instance \n);\n")),(0,a.kt)("h3",{id:"tenup_headless_wp_render_blocks_attrs_serialized"},"tenup_headless_wp_render_blocks_attrs_serialized"),(0,a.kt)("p",null,"This filter is not as useful as the previous one but it allows you to filter the serialized attributes."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-php"},"/**\n * Filter's out the block's attributes after serialization\n *\n * @param string $encoded_attrs The serialized block's Attributes\n * @param array $attrs The Block's Attributes\n * @param array $block The Block's schema\n * @param \\WP_Block $block_instance The block's instance\n */\n$block_attrs_serialized = apply_filters(\n 'tenup_headless_wp_render_blocks_attrs_serialized',\n esc_attr( wp_json_encode( $block_attrs ) ),\n $block_attrs,\n $block,\n $block_instance\n);\n")),(0,a.kt)("h3",{id:"tenup_headless_wp_render_block_use_tag_processor"},"tenup_headless_wp_render_block_use_tag_processor"),(0,a.kt)("p",null,"HeadstartWP will use the DomDocument API for parsing and enhancing the block markup by default. Since 1.0.7, it is possible to opt into the new ",(0,a.kt)("inlineCode",{parentName:"p"},"WP_Html_Tag_Processor")," API via the ",(0,a.kt)("inlineCode",{parentName:"p"},"tenup_headless_wp_render_block_use_tag_processor"),"."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-php"},"add_filter( 'tenup_headless_wp_render_block_use_tag_processor', '__return_true' );\n")),(0,a.kt)("p",null,"In the next major release, usage of the DomDocument API will be removed in favor of ",(0,a.kt)("inlineCode",{parentName:"p"},"WP_Html_Tag_Processor")," since it's easier to use and a core API. For most users this should not change anything, both APIs should yield the same result and the deprecation of the DomDocument API is merely for simplicity."),(0,a.kt)("h3",{id:"tenup_headless_wp_render_block_markup"},"tenup_headless_wp_render_block_markup"),(0,a.kt)("p",null,"This filter is called after adding the data attributes but before returning the block's final markup. You can use this filter to perform any additional modifications to the block markup."),(0,a.kt)("p",null,"This filter is only called when using the DomDocument API (i.e - the filter ",(0,a.kt)("inlineCode",{parentName:"p"},"tenup_headless_wp_render_block_use_tag_processor")," returns false)."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-php"},"/**\n * Filter the block's DOMElement before rendering\n *\n * @param \\DOMElement $root_node\n * @param string $html The original block markup\n * @param array $block The Block's schema\n * @param \\WP_Block $block_instance The block's instance\n */\n$root_node = apply_filters( \n 'tenup_headless_wp_render_block_markup', \n $root_node, \n $html, \n $block, \n $block_instance\n);\n")),(0,a.kt)("h3",{id:"tenup_headless_wp_render_html_tag_processor_block_markup"},"tenup_headless_wp_render_html_tag_processor_block_markup"),(0,a.kt)("p",null,"This filter is called after adding the data attributes but before returning the block's final markup when the ",(0,a.kt)("inlineCode",{parentName:"p"},"WP_HTML_Tag_Processor")," API is being used. You can use this filter to perform any additional modifications to the block markup."),(0,a.kt)("p",null,"This filter is only called when using the WP_HTML_Tag_Processor API (i.e - the filter ",(0,a.kt)("inlineCode",{parentName:"p"},"tenup_headless_wp_render_block_use_tag_processor")," returns true)."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-php"},"/**\n * Filter the block's before rendering\n *\n * @param \\WP_HTML_Tag_Processor $doc\n * @param string $html The original block markup\n * @param array $block The Block's schema\n * @param \\WP_Block $block_instance The block's instance\n */\n$doc = apply_filters( \n 'tenup_headless_wp_render_html_tag_processor_block_markup', \n $doc, \n $html, \n $block, \n $block_instance\n);\n")))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/f46c6fb7.a57c4fb4.js b/assets/js/f46c6fb7.0af5512c.js similarity index 96% rename from assets/js/f46c6fb7.a57c4fb4.js rename to assets/js/f46c6fb7.0af5512c.js index 9948c8b01..0c75a9c06 100644 --- a/assets/js/f46c6fb7.a57c4fb4.js +++ b/assets/js/f46c6fb7.0af5512c.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1656],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),c=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return n.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=r,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||o;return a?n.createElement(h,l(l({ref:t},d),{},{components:a})):n.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=a.length,l=new Array(o);l[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:r,l[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var n=a(7462),r=(a(7294),a(3905));const o={id:"headstartwp_core.react.IButtonsBlock",title:"Interface: IButtonsBlock",sidebar_label:"@headstartwp/core.react.IButtonsBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IButtonsBlock",id:"interfaces/headstartwp_core.react.IButtonsBlock",title:"Interface: IButtonsBlock",description:"@headstartwp/core.react.IButtonsBlock",source:"@site/docs/interfaces/headstartwp_core.react.IButtonsBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IButtonsBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IButtonsBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IButtonsBlock",title:"Interface: IButtonsBlock",sidebar_label:"@headstartwp/core.react.IButtonsBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IButtonBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IButtonBlock"},next:{title:"@headstartwp/core.react.ICodeBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ICodeBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IButtonsBlock"),(0,r.kt)("p",null,"The interface for the ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#buttonsblock"},"ButtonsBlock")," component."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ButtonsBlockProps")),">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"IButtonsBlock"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"children"},"children"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"children"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,r.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,r.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classlist"},"classList"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"classList"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classname"},"className"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"className"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"component"},"component"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"component"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ButtonsBlockProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ButtonsBlockProps")))))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domnode"},"domNode"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"domNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,r.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,r.kt)("h5",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"childNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h5",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"style"},"style"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"style"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The style tag of the domNode as an object."),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tagname"},"tagName"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tagName"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[1656],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>h});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=n.createContext({}),c=function(e){var t=n.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},d=function(e){var t=c(e.components);return n.createElement(p.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),s=c(a),m=r,h=s["".concat(p,".").concat(m)]||s[m]||k[m]||o;return a?n.createElement(h,l(l({ref:t},d),{},{components:a})):n.createElement(h,l({ref:t},d))}));function h(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=a.length,l=new Array(o);l[0]=m;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[s]="string"==typeof e?e:r,l[1]=i;for(var c=2;c{a.r(t),a.d(t,{assets:()=>p,contentTitle:()=>l,default:()=>s,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var n=a(7462),r=(a(7294),a(3905));const o={id:"headstartwp_core.react.IButtonsBlock",title:"Interface: IButtonsBlock",sidebar_label:"@headstartwp/core.react.IButtonsBlock",custom_edit_url:null},l=void 0,i={unversionedId:"interfaces/headstartwp_core.react.IButtonsBlock",id:"interfaces/headstartwp_core.react.IButtonsBlock",title:"Interface: IButtonsBlock",description:"@headstartwp/core.react.IButtonsBlock",source:"@site/docs/interfaces/headstartwp_core.react.IButtonsBlock.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.IButtonsBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IButtonsBlock",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.IButtonsBlock",title:"Interface: IButtonsBlock",sidebar_label:"@headstartwp/core.react.IButtonsBlock",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.IButtonBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.IButtonBlock"},next:{title:"@headstartwp/core.react.ICodeBlock",permalink:"/docs/api/interfaces/headstartwp_core.react.ICodeBlock"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"classList",id:"classlist",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"component",id:"component",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"exclude",id:"exclude",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"tagName",id:"tagname",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:c};function s(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".IButtonsBlock"),(0,r.kt)("p",null,"The interface for the ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react#buttonsblock"},"ButtonsBlock")," component."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},(0,r.kt)("inlineCode",{parentName:"a"},"IBlock")),"<",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ButtonsBlockProps")),">"),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"IButtonsBlock"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"children"},"children"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"children"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,r.kt)("p",null,"The children of the domNode that was replaced with the react component"),(0,r.kt)("p",null,"Note: the children of the domNode are recursively parsed."),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#children"},"children")),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L53"},"packages/core/src/react/components/BlocksRenderer.tsx:53")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classlist"},"classList"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"classList"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"The class name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If tagName is specified, then classList is mandatory"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classlist"},"classList")),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L41"},"packages/core/src/react/components/BlocksRenderer.tsx:41")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"classname"},"className"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"className"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#classname"},"className")),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L66"},"packages/core/src/react/components/BlocksRenderer.tsx:66")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"component"},"component"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"component"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ButtonsBlockProps")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"props"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h5",{id:"parameters"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"props")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps"},(0,r.kt)("inlineCode",{parentName:"a"},"ButtonsBlockProps")))))),(0,r.kt)("h5",{id:"returns"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"ReactElement"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"JSXElementConstructor"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">",">"),(0,r.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#component"},"component")),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L67"},"packages/core/src/react/components/BlocksRenderer.tsx:67")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"domnode"},"domNode"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"domNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element"))),(0,r.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#domnode"},"domNode")),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L65"},"packages/core/src/react/components/BlocksRenderer.tsx:65")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"exclude"},"exclude"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"exclude"),": (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),": ",(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")),") => ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,r.kt)("p",null,"\u25b8 (",(0,r.kt)("inlineCode",{parentName:"p"},"childNode"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"site?"),"): ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"An optional exclude function that also receives a domNode and is executed against every child\nof the node being replaced with a react component."),(0,r.kt)("p",null,"This is useful to selectively disregard certain children of a node when replacing with a react component."),(0,r.kt)("h5",{id:"parameters-1"},"Parameters"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,r.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"childNode")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/classes/headstartwp_core.Element"},(0,r.kt)("inlineCode",{parentName:"a"},"Element")))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("inlineCode",{parentName:"td"},"site?")),(0,r.kt)("td",{parentName:"tr",align:"left"},(0,r.kt)("a",{parentName:"td",href:"/docs/api/modules/headstartwp_core#headlessconfig"},(0,r.kt)("inlineCode",{parentName:"a"},"HeadlessConfig")))))),(0,r.kt)("h5",{id:"returns-1"},"Returns"),(0,r.kt)("p",null,(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#exclude"},"exclude")),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L27"},"packages/core/src/react/components/BlocksRenderer.tsx:27")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"style"},"style"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"style"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,r.kt)("p",null,"The style tag of the domNode as an object."),(0,r.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#style"},"style")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L58"},"packages/core/src/react/components/BlocksRenderer.tsx:58")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"tagname"},"tagName"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"tagName"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The tag name of the domNode that should be replaced with the react component"),(0,r.kt)("p",null,"If a test function is not supplied, then passing tagName is mandatory"),(0,r.kt)("h4",{id:"inherited-from-7"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock"},"IBlock"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlock#tagname"},"tagName")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/components/BlocksRenderer.tsx#L34"},"packages/core/src/react/components/BlocksRenderer.tsx:34")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/f78eec9e.78b61820.js b/assets/js/f78eec9e.d5aaf7d9.js similarity index 75% rename from assets/js/f78eec9e.78b61820.js rename to assets/js/f78eec9e.d5aaf7d9.js index 8c781b12f..64c18c440 100644 --- a/assets/js/f78eec9e.78b61820.js +++ b/assets/js/f78eec9e.d5aaf7d9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8239],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>k});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function p(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var o=a.createContext({}),l=function(e){var t=a.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):p(p({},t),e)),n},d=function(e){var t=l(e.components);return a.createElement(o.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,o=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),c=l(n),u=r,k=c["".concat(o,".").concat(u)]||c[u]||h[u]||i;return n?a.createElement(k,p(p({ref:t},d),{},{components:n})):a.createElement(k,p({ref:t},d))}));function k(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,p=new Array(i);p[0]=u;var s={};for(var o in t)hasOwnProperty.call(t,o)&&(s[o]=t[o]);s.originalType=e,s[c]="string"==typeof e?e:r,p[1]=s;for(var l=2;l{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var a=n(7462),r=(n(7294),n(3905));const i={id:"headstartwp_core.TypeEntity",title:"Interface: TypeEntity",sidebar_label:"@headstartwp/core.TypeEntity",custom_edit_url:null},p=void 0,s={unversionedId:"interfaces/headstartwp_core.TypeEntity",id:"interfaces/headstartwp_core.TypeEntity",title:"Interface: TypeEntity",description:"@headstartwp/core.TypeEntity",source:"@site/docs/interfaces/headstartwp_core.TypeEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.TypeEntity",permalink:"/docs/api/interfaces/headstartwp_core.TypeEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.TypeEntity",title:"Interface: TypeEntity",sidebar_label:"@headstartwp/core.TypeEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.TermSearchEntity",permalink:"/docs/api/interfaces/headstartwp_core.TermSearchEntity"},next:{title:"@headstartwp/core.VerifyTokenParams",permalink:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams"}},o={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"hierarchical",id:"hierarchical",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"rest_base",id:"rest_base",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"taxonomies",id:"taxonomies",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:l};function c(e){let{components:t,...n}=e;return(0,r.kt)("wrapper",(0,a.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".TypeEntity"),(0,r.kt)("p",null,"Interface for entities from the /wp/v2/types endpoint."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,r.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"TypeEntity"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"A human-readable description of the post type."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L362"},"packages/core/src/data/types/entities.ts:362")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hierarchical"},"hierarchical"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"hierarchical"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Whether or not the post type should have children."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L367"},"packages/core/src/data/types/entities.ts:367")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The title for the post type."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L372"},"packages/core/src/data/types/entities.ts:372")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"rest_base"},"rest","_","base"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"rest","_","base"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"REST base route for the post type."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L382"},"packages/core/src/data/types/entities.ts:382")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"slug"},"slug"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"An alphanumeric identifier for the post type."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L377"},"packages/core/src/data/types/entities.ts:377")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"taxonomies"},"taxonomies"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"taxonomies"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Taxonomies associated with post type."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L387"},"packages/core/src/data/types/entities.ts:387")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}c.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[8239],{3905:(e,t,a)=>{a.d(t,{Zo:()=>d,kt:()=>k});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function p(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var o=n.createContext({}),l=function(e){var t=n.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):p(p({},t),e)),a},d=function(e){var t=l(e.components);return n.createElement(o.Provider,{value:t},e.children)},c="mdxType",h={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,o=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),c=l(a),u=r,k=c["".concat(o,".").concat(u)]||c[u]||h[u]||i;return a?n.createElement(k,p(p({ref:t},d),{},{components:a})):n.createElement(k,p({ref:t},d))}));function k(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,p=new Array(i);p[0]=u;var s={};for(var o in t)hasOwnProperty.call(t,o)&&(s[o]=t[o]);s.originalType=e,s[c]="string"==typeof e?e:r,p[1]=s;for(var l=2;l{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>p,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var n=a(7462),r=(a(7294),a(3905));const i={id:"headstartwp_core.TypeEntity",title:"Interface: TypeEntity",sidebar_label:"@headstartwp/core.TypeEntity",custom_edit_url:null},p=void 0,s={unversionedId:"interfaces/headstartwp_core.TypeEntity",id:"interfaces/headstartwp_core.TypeEntity",title:"Interface: TypeEntity",description:"@headstartwp/core.TypeEntity",source:"@site/docs/interfaces/headstartwp_core.TypeEntity.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.TypeEntity",permalink:"/docs/api/interfaces/headstartwp_core.TypeEntity",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.TypeEntity",title:"Interface: TypeEntity",sidebar_label:"@headstartwp/core.TypeEntity",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.TermSearchEntity",permalink:"/docs/api/interfaces/headstartwp_core.TermSearchEntity"},next:{title:"@headstartwp/core.VerifyTokenParams",permalink:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams"}},o={},l=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"description",id:"description",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"hierarchical",id:"hierarchical",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"rest_base",id:"rest_base",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"slug",id:"slug",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"taxonomies",id:"taxonomies",level:3},{value:"Defined in",id:"defined-in-5",level:4},{value:"yoast_head",id:"yoast_head",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"yoast_head_json",id:"yoast_head_json",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-7",level:4}],d={toc:l};function c(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},d,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".TypeEntity"),(0,r.kt)("p",null,"Interface for entities from the /wp/v2/types endpoint."),(0,r.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},(0,r.kt)("inlineCode",{parentName:"a"},"Entity"))),(0,r.kt)("p",{parentName:"li"},"\u21b3 ",(0,r.kt)("strong",{parentName:"p"},(0,r.kt)("inlineCode",{parentName:"strong"},"TypeEntity"))))),(0,r.kt)("h2",{id:"properties"},"Properties"),(0,r.kt)("h3",{id:"description"},"description"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"description"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"A human-readable description of the post type."),(0,r.kt)("h4",{id:"defined-in"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L362"},"packages/core/src/data/types/entities.ts:362")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"hierarchical"},"hierarchical"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"hierarchical"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"boolean")),(0,r.kt)("p",null,"Whether or not the post type should have children."),(0,r.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L367"},"packages/core/src/data/types/entities.ts:367")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"name"},"name"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"name"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"The title for the post type."),(0,r.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L372"},"packages/core/src/data/types/entities.ts:372")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"rest_base"},"rest","_","base"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"rest","_","base"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"REST base route for the post type."),(0,r.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L382"},"packages/core/src/data/types/entities.ts:382")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"slug"},"slug"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"slug"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("p",null,"An alphanumeric identifier for the post type."),(0,r.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L377"},"packages/core/src/data/types/entities.ts:377")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"taxonomies"},"taxonomies"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("strong",{parentName:"p"},"taxonomies"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"string"),"[]"),(0,r.kt)("p",null,"Taxonomies associated with post type."),(0,r.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L387"},"packages/core/src/data/types/entities.ts:387")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head"},"yoast","_","head"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"string")),(0,r.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head"},"yoast_head")),(0,r.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L14"},"packages/core/src/data/types/entities.ts:14")),(0,r.kt)("hr",null),(0,r.kt)("h3",{id:"yoast_head_json"},"yoast","_","head","_","json"),(0,r.kt)("p",null,"\u2022 ",(0,r.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,r.kt)("strong",{parentName:"p"},"yoast","_","head","_","json"),": ",(0,r.kt)("inlineCode",{parentName:"p"},"null")," ","|"," ",(0,r.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,r.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"any"),">"),(0,r.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity"},"Entity"),".",(0,r.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.Entity#yoast_head_json"},"yoast_head_json")),(0,r.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/data/types/entities.ts#L13"},"packages/core/src/data/types/entities.ts:13")))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/f9e6d01e.d280eeaf.js b/assets/js/f9e6d01e.d3b6f470.js similarity index 96% rename from assets/js/f9e6d01e.d280eeaf.js rename to assets/js/f9e6d01e.d3b6f470.js index bc5bdfb93..efa8dbb04 100644 --- a/assets/js/f9e6d01e.d280eeaf.js +++ b/assets/js/f9e6d01e.d3b6f470.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9898],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>f});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function s(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},l="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),l=c(r),h=n,f=l["".concat(p,".").concat(h)]||l[h]||u[h]||o;return r?a.createElement(f,s(s({ref:t},d),{},{components:r})):a.createElement(f,s({ref:t},d))}));function f(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,s=new Array(o);s[0]=h;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[l]="string"==typeof e?e:n,s[1]=i;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.useMenuResponse",title:"Interface: useMenuResponse",sidebar_label:"@headstartwp/core.react.useMenuResponse",custom_edit_url:null},s=void 0,i={unversionedId:"interfaces/headstartwp_core.react.useMenuResponse",id:"interfaces/headstartwp_core.react.useMenuResponse",title:"Interface: useMenuResponse",description:"@headstartwp/core.react.useMenuResponse",source:"@site/docs/interfaces/headstartwp_core.react.useMenuResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.useMenuResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.useMenuResponse",title:"Interface: useMenuResponse",sidebar_label:"@headstartwp/core.react.useMenuResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.useFetchOptions",permalink:"/docs/api/interfaces/headstartwp_core.react.useFetchOptions"},next:{title:"@headstartwp/core.react.usePostOrPostResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],d={toc:c};function l(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".useMenuResponse"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"useMenuResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"MenuItemEntity")),"[]"),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/useFetchMenu.ts#L7"},"packages/core/src/react/hooks/useFetchMenu.ts:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")))}l.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[9898],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>f});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function s(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},d=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},l="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),l=c(r),h=n,f=l["".concat(p,".").concat(h)]||l[h]||u[h]||o;return r?a.createElement(f,s(s({ref:t},d),{},{components:r})):a.createElement(f,s({ref:t},d))}));function f(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,s=new Array(o);s[0]=h;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i[l]="string"==typeof e?e:n,s[1]=i;for(var c=2;c{r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var a=r(7462),n=(r(7294),r(3905));const o={id:"headstartwp_core.react.useMenuResponse",title:"Interface: useMenuResponse",sidebar_label:"@headstartwp/core.react.useMenuResponse",custom_edit_url:null},s=void 0,i={unversionedId:"interfaces/headstartwp_core.react.useMenuResponse",id:"interfaces/headstartwp_core.react.useMenuResponse",title:"Interface: useMenuResponse",description:"@headstartwp/core.react.useMenuResponse",source:"@site/docs/interfaces/headstartwp_core.react.useMenuResponse.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.useMenuResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.useMenuResponse",title:"Interface: useMenuResponse",sidebar_label:"@headstartwp/core.react.useMenuResponse",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.useFetchOptions",permalink:"/docs/api/interfaces/headstartwp_core.react.useFetchOptions"},next:{title:"@headstartwp/core.react.usePostOrPostResponse",permalink:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse"}},p={},c=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"data",id:"data",level:3},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"error",id:"error",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"isMainQuery",id:"ismainquery",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"loading",id:"loading",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4}],d={toc:c};function l(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".useMenuResponse"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},(0,n.kt)("inlineCode",{parentName:"a"},"HookResponse"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"useMenuResponse"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"data"},"data"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"data"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.MenuItemEntity"},(0,n.kt)("inlineCode",{parentName:"a"},"MenuItemEntity")),"[]"),(0,n.kt)("h4",{id:"overrides"},"Overrides"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#data"},"data")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/useFetchMenu.ts#L7"},"packages/core/src/react/hooks/useFetchMenu.ts:7")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"error"},"error"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"error"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#error"},"error")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L6"},"packages/core/src/react/hooks/types.ts:6")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"ismainquery"},"isMainQuery"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"isMainQuery"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#ismainquery"},"isMainQuery")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L8"},"packages/core/src/react/hooks/types.ts:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"loading"},"loading"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"loading"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"boolean")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse"},"HookResponse"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.HookResponse#loading"},"loading")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/hooks/types.ts#L7"},"packages/core/src/react/hooks/types.ts:7")))}l.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/fa160712.a204526c.js b/assets/js/fa160712.7c4df578.js similarity index 99% rename from assets/js/fa160712.a204526c.js rename to assets/js/fa160712.7c4df578.js index 8c83ee3b7..c624ce3fa 100644 --- a/assets/js/fa160712.a204526c.js +++ b/assets/js/fa160712.7c4df578.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3589],{3905:(e,t,a)=>{a.d(t,{Zo:()=>p,kt:()=>m});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function s(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var c=n.createContext({}),l=function(e){var t=n.useContext(c),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},p=function(e){var t=l(e.components);return n.createElement(c.Provider,{value:t},e.children)},h="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,s=e.originalType,c=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),h=l(a),d=r,m=h["".concat(c,".").concat(d)]||h[d]||u[d]||s;return a?n.createElement(m,i(i({ref:t},p),{},{components:a})):n.createElement(m,i({ref:t},p))}));function m(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var s=a.length,i=new Array(s);i[0]=d;var o={};for(var c in t)hasOwnProperty.call(t,c)&&(o[c]=t[c]);o.originalType=e,o[h]="string"==typeof e?e:r,i[1]=o;for(var l=2;l{a.r(t),a.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>s,metadata:()=>o,toc:()=>l});var n=a(7462),r=(a(7294),a(3905));const s={slug:"/data-fetching/usesearch-native",sidebar_position:5},i="The useSearchNative hook",o={unversionedId:"Data Fetching/useSearchNative",id:"Data Fetching/useSearchNative",title:"The useSearchNative hook",description:"The useSearchNative hook is the Next.js binding for the useFetchSearchNative.",source:"@site/documentation/02 - Data Fetching/useSearchNative.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/usesearch-native",permalink:"/docs/learn/data-fetching/usesearch-native",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/useSearchNative.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",sidebarPosition:5,frontMatter:{slug:"/data-fetching/usesearch-native",sidebar_position:5},sidebar:"tutorialSidebar",previous:{title:"The useSearch hook",permalink:"/docs/learn/data-fetching/usesearch"},next:{title:"The useSeo hook",permalink:"/docs/learn/data-fetching/useSeo"}},c={},l=[{value:"Basic Usage",id:"basic-usage",level:2},{value:"Searching from multiple post types",id:"searching-from-multiple-post-types",level:2},{value:"Searching for terms",id:"searching-for-terms",level:2},{value:"Accessing embeddable data",id:"accessing-embeddable-data",level:2},{value:"QueriedObject",id:"queriedobject",level:2}],p={toc:l};function h(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},p,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"the-usesearchnative-hook"},"The useSearchNative hook"),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},"The ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next#usesearchnative"},"useSearchNative")," hook is the Next.js binding for the ",(0,r.kt)("a",{parentName:"p",href:"/api/namespaces/headstartwp_core.react#usefetchsearchnative"},"useFetchSearchNative"),".")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"useSearchNative")," hook is the implementation of core ",(0,r.kt)("a",{parentName:"p",href:"https://developer.wordpress.org/rest-api/reference/search-results/"},"Search Results")," endpoint."),(0,r.kt)("admonition",{type:"caution"},(0,r.kt)("p",{parentName:"admonition"},"This hook was introduced in ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/core@1.3.0"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/next@1.3.0")," and requires the the HeadstartWP WordPress plugin >= 1.1.0")),(0,r.kt)("p",null,"The headstartwp WordPress plugin does additional customizations to ensure the Search Results endpoints return all the embeddable data associated with search results."),(0,r.kt)("h2",{id:"basic-usage"},"Basic Usage"),(0,r.kt)("p",null,"Assuming a ",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/search/[[...path]].js")," route with the following content."),(0,r.kt)("admonition",{type:"info"},(0,r.kt)("p",{parentName:"admonition"},"This example is using the optional catch-all route ",(0,r.kt)("inlineCode",{parentName:"p"},"[[..path]].js")," because we want the ",(0,r.kt)("inlineCode",{parentName:"p"},"/search")," route to be handled by the same file and fetch the latest posts.")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/search/[[...path]].js"',title:'"src/pages/search/[[...path]].js"'},"import { useSearchNative } from '@headstartwp/next';\n\nconst ArchivePage = () => {\n const { loading, error, data } = useSearchNative({ per_page: 10 });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n if (data.pageInfo.totalItems === 0) {\n return 'Nothing found';\n }\n\n return (\n <>\n

Search Results

\n
    \n {data.searchResults.map((item) => (\n
  • \n \n {item.id} - {item.title}\n \n
    • \n ))}\n
\n \n );\n};\n")),(0,r.kt)("p",null,"The route will automatically render the latest 10 results if no search term is provided. The following paths are automatically handled:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"/search/search-term"),(0,r.kt)("li",{parentName:"ul"},"/search/search-term/page/2"),(0,r.kt)("li",{parentName:"ul"},"/search")),(0,r.kt)("h2",{id:"searching-from-multiple-post-types"},"Searching from multiple post types"),(0,r.kt)("p",null,"You can specify any of the supported parameters described in the ",(0,r.kt)("a",{parentName:"p",href:"https://developer.wordpress.org/rest-api/reference/search-results/#arguments"},"Search Results")," endpoint documentation."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/search/[[...path]].js"',title:'"src/pages/search/[[...path]].js"'},"import { useSearchNative } from '@headstartwp/next';\n\nconst ArchivePage = () => {\n const { loading, error, data } = useSearchNative({ \n per_page: 10, \n type: 'post', \n subtype: ['post', 'page'] \n });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n if (data.pageInfo.totalItems === 0) {\n return 'Nothing found';\n }\n\n return (\n <>\n

Search Results

\n
    \n {data.searchResults.map((item) => (\n
  • \n \n {item.id} - {item.title}\n \n
    • \n ))}\n
\n \n );\n};\n")),(0,r.kt)("h2",{id:"searching-for-terms"},"Searching for terms"),(0,r.kt)("p",null,"You can also search for terms:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/terms/search/[[...path]].js"',title:'"src/pages/terms/search/[[...path]].js"'},"import { useSearch } from '@headstartwp/next';\n\nconst ArchivePage = () => {\n const { loading, error, data } = useSearchNative({ \n per_page: 10, \n type: 'term',\n subtype: ['category', 'category'] \n });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n if (data.pageInfo.totalItems === 0) {\n return 'Nothing found';\n }\n\n return (\n <>\n

Search Results

\n
    \n {data.searchResults.map((item) => (\n
  • \n \n {item.id} - {item.title}\n \n
    • \n ))}\n
\n \n );\n};\n")),(0,r.kt)("h2",{id:"accessing-embeddable-data"},"Accessing embeddable data"),(0,r.kt)("p",null,"By default, the Search Results endpoints only return the object of the associated search results but do not return embeddable data of the search results entities themselves. For instance, when searching for posts, even if you pass the ",(0,r.kt)("inlineCode",{parentName:"p"},"_embed")," parameter, WordPress won't return the associated term objects, author objects etc."),(0,r.kt)("p",null,"HeadstartWP plugin extends the core endpoint so that it returns these embedded objects to avoid the need for additional queries. Check the ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/headstartwp_core.PostSearchEntity/"},"PostSearchEntity")," and ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/headstartwp_core.TermSearchEntity/"},"TermSearcheEntity"),"."),(0,r.kt)("h2",{id:"queriedobject"},"QueriedObject"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"useNativeSearch")," hook also exposes a ",(0,r.kt)("inlineCode",{parentName:"p"},"queriedObject"),"."),(0,r.kt)("p",null,"The queried object for this hook is an object of type ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/headstartwp_core.SearchEntity/"},"SearchEntity"),"."))}h.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[3589],{3905:(e,t,a)=>{a.d(t,{Zo:()=>p,kt:()=>m});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function s(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var s=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var c=n.createContext({}),l=function(e){var t=n.useContext(c),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},p=function(e){var t=l(e.components);return n.createElement(c.Provider,{value:t},e.children)},h="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,s=e.originalType,c=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),h=l(a),d=r,m=h["".concat(c,".").concat(d)]||h[d]||u[d]||s;return a?n.createElement(m,i(i({ref:t},p),{},{components:a})):n.createElement(m,i({ref:t},p))}));function m(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var s=a.length,i=new Array(s);i[0]=d;var o={};for(var c in t)hasOwnProperty.call(t,c)&&(o[c]=t[c]);o.originalType=e,o[h]="string"==typeof e?e:r,i[1]=o;for(var l=2;l{a.r(t),a.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>s,metadata:()=>o,toc:()=>l});var n=a(7462),r=(a(7294),a(3905));const s={slug:"/data-fetching/usesearch-native",sidebar_position:5},i="The useSearchNative hook",o={unversionedId:"Data Fetching/useSearchNative",id:"Data Fetching/useSearchNative",title:"The useSearchNative hook",description:"The useSearchNative hook is the Next.js binding for the useFetchSearchNative.",source:"@site/documentation/02 - Data Fetching/useSearchNative.md",sourceDirName:"02 - Data Fetching",slug:"/data-fetching/usesearch-native",permalink:"/docs/learn/data-fetching/usesearch-native",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/02 - Data Fetching/useSearchNative.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",sidebarPosition:5,frontMatter:{slug:"/data-fetching/usesearch-native",sidebar_position:5},sidebar:"tutorialSidebar",previous:{title:"The useSearch hook",permalink:"/docs/learn/data-fetching/usesearch"},next:{title:"The useSeo hook",permalink:"/docs/learn/data-fetching/useSeo"}},c={},l=[{value:"Basic Usage",id:"basic-usage",level:2},{value:"Searching from multiple post types",id:"searching-from-multiple-post-types",level:2},{value:"Searching for terms",id:"searching-for-terms",level:2},{value:"Accessing embeddable data",id:"accessing-embeddable-data",level:2},{value:"QueriedObject",id:"queriedobject",level:2}],p={toc:l};function h(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},p,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"the-usesearchnative-hook"},"The useSearchNative hook"),(0,r.kt)("blockquote",null,(0,r.kt)("p",{parentName:"blockquote"},"The ",(0,r.kt)("a",{parentName:"p",href:"/api/modules/headstartwp_next#usesearchnative"},"useSearchNative")," hook is the Next.js binding for the ",(0,r.kt)("a",{parentName:"p",href:"/api/namespaces/headstartwp_core.react#usefetchsearchnative"},"useFetchSearchNative"),".")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"useSearchNative")," hook is the implementation of core ",(0,r.kt)("a",{parentName:"p",href:"https://developer.wordpress.org/rest-api/reference/search-results/"},"Search Results")," endpoint."),(0,r.kt)("admonition",{type:"caution"},(0,r.kt)("p",{parentName:"admonition"},"This hook was introduced in ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/core@1.3.0"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"@headstartwp/next@1.3.0")," and requires the the HeadstartWP WordPress plugin >= 1.1.0")),(0,r.kt)("p",null,"The headstartwp WordPress plugin does additional customizations to ensure the Search Results endpoints return all the embeddable data associated with search results."),(0,r.kt)("h2",{id:"basic-usage"},"Basic Usage"),(0,r.kt)("p",null,"Assuming a ",(0,r.kt)("inlineCode",{parentName:"p"},"src/pages/search/[[...path]].js")," route with the following content."),(0,r.kt)("admonition",{type:"info"},(0,r.kt)("p",{parentName:"admonition"},"This example is using the optional catch-all route ",(0,r.kt)("inlineCode",{parentName:"p"},"[[..path]].js")," because we want the ",(0,r.kt)("inlineCode",{parentName:"p"},"/search")," route to be handled by the same file and fetch the latest posts.")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/search/[[...path]].js"',title:'"src/pages/search/[[...path]].js"'},"import { useSearchNative } from '@headstartwp/next';\n\nconst ArchivePage = () => {\n const { loading, error, data } = useSearchNative({ per_page: 10 });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n if (data.pageInfo.totalItems === 0) {\n return 'Nothing found';\n }\n\n return (\n <>\n

Search Results

\n
    \n {data.searchResults.map((item) => (\n
  • \n \n {item.id} - {item.title}\n \n
    • \n ))}\n
\n \n );\n};\n")),(0,r.kt)("p",null,"The route will automatically render the latest 10 results if no search term is provided. The following paths are automatically handled:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"/search/search-term"),(0,r.kt)("li",{parentName:"ul"},"/search/search-term/page/2"),(0,r.kt)("li",{parentName:"ul"},"/search")),(0,r.kt)("h2",{id:"searching-from-multiple-post-types"},"Searching from multiple post types"),(0,r.kt)("p",null,"You can specify any of the supported parameters described in the ",(0,r.kt)("a",{parentName:"p",href:"https://developer.wordpress.org/rest-api/reference/search-results/#arguments"},"Search Results")," endpoint documentation."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/search/[[...path]].js"',title:'"src/pages/search/[[...path]].js"'},"import { useSearchNative } from '@headstartwp/next';\n\nconst ArchivePage = () => {\n const { loading, error, data } = useSearchNative({ \n per_page: 10, \n type: 'post', \n subtype: ['post', 'page'] \n });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n if (data.pageInfo.totalItems === 0) {\n return 'Nothing found';\n }\n\n return (\n <>\n

Search Results

\n
    \n {data.searchResults.map((item) => (\n
  • \n \n {item.id} - {item.title}\n \n
    • \n ))}\n
\n \n );\n};\n")),(0,r.kt)("h2",{id:"searching-for-terms"},"Searching for terms"),(0,r.kt)("p",null,"You can also search for terms:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js",metastring:'title="src/pages/terms/search/[[...path]].js"',title:'"src/pages/terms/search/[[...path]].js"'},"import { useSearch } from '@headstartwp/next';\n\nconst ArchivePage = () => {\n const { loading, error, data } = useSearchNative({ \n per_page: 10, \n type: 'term',\n subtype: ['category', 'category'] \n });\n\n if (loading) {\n return 'Loading...';\n }\n\n if (error) {\n return 'error...';\n }\n\n if (data.pageInfo.totalItems === 0) {\n return 'Nothing found';\n }\n\n return (\n <>\n

Search Results

\n
    \n {data.searchResults.map((item) => (\n
  • \n \n {item.id} - {item.title}\n \n
    • \n ))}\n
\n \n );\n};\n")),(0,r.kt)("h2",{id:"accessing-embeddable-data"},"Accessing embeddable data"),(0,r.kt)("p",null,"By default, the Search Results endpoints only return the object of the associated search results but do not return embeddable data of the search results entities themselves. For instance, when searching for posts, even if you pass the ",(0,r.kt)("inlineCode",{parentName:"p"},"_embed")," parameter, WordPress won't return the associated term objects, author objects etc."),(0,r.kt)("p",null,"HeadstartWP plugin extends the core endpoint so that it returns these embedded objects to avoid the need for additional queries. Check the ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/headstartwp_core.PostSearchEntity/"},"PostSearchEntity")," and ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/headstartwp_core.TermSearchEntity/"},"TermSearcheEntity"),"."),(0,r.kt)("h2",{id:"queriedobject"},"QueriedObject"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"useNativeSearch")," hook also exposes a ",(0,r.kt)("inlineCode",{parentName:"p"},"queriedObject"),"."),(0,r.kt)("p",null,"The queried object for this hook is an object of type ",(0,r.kt)("a",{parentName:"p",href:"/api/interfaces/headstartwp_core.SearchEntity/"},"SearchEntity"),"."))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/fae21d27.7394b6e9.js b/assets/js/fae21d27.6451c5cd.js similarity index 97% rename from assets/js/fae21d27.7394b6e9.js rename to assets/js/fae21d27.6451c5cd.js index 145e68b0e..cf748550f 100644 --- a/assets/js/fae21d27.7394b6e9.js +++ b/assets/js/fae21d27.6451c5cd.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2179],{3905:(e,t,r)=>{r.d(t,{Zo:()=>u,kt:()=>h});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function s(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var l=n.createContext({}),d=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},u=function(e){var t=d(e.components);return n.createElement(l.Provider,{value:t},e.children)},p="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,l=e.parentName,u=i(e,["components","mdxType","originalType","parentName"]),p=d(r),f=o,h=p["".concat(l,".").concat(f)]||p[f]||c[f]||a;return r?n.createElement(h,s(s({ref:t},u),{},{components:r})):n.createElement(h,s({ref:t},u))}));function h(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,s=new Array(a);s[0]=f;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[p]="string"==typeof e?e:o,s[1]=i;for(var d=2;d{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>p,frontMatter:()=>a,metadata:()=>i,toc:()=>d});var n=r(7462),o=(r(7294),r(3905));const a={slug:"/wordpress-integration/feeds"},s="Feeds",i={unversionedId:"WordPress Integration/feeds",id:"WordPress Integration/feeds",title:"Feeds",description:"Feeds are proxied via Next.js rewrites by default. meaning that you can directly access the feed via your front-end/Next.js URL.",source:"@site/documentation/06-WordPress Integration/feeds.md",sourceDirName:"06-WordPress Integration",slug:"/wordpress-integration/feeds",permalink:"/docs/learn/wordpress-integration/feeds",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/06-WordPress Integration/feeds.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",frontMatter:{slug:"/wordpress-integration/feeds"},sidebar:"tutorialSidebar",previous:{title:"Basic Auth",permalink:"/docs/learn/wordpress-integration/basic-auth"},next:{title:"Gutenberg",permalink:"/docs/learn/wordpress-integration/gutenberg"}},l={},d=[{value:"Filtering when to rewrite URLs",id:"filtering-when-to-rewrite-urls",level:2}],u={toc:d};function p(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,n.Z)({},u,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"feeds"},"Feeds"),(0,o.kt)("p",null,"Feeds are proxied via Next.js rewrites by default. meaning that you can directly access the feed via your front-end/Next.js URL."),(0,o.kt)("p",null,"If you have the plugin enabled, the URLs in the feed will also be rewritten to use front-end URLs. URLs are only rewritten if ",(0,o.kt)("inlineCode",{parentName:"p"},"?rewrite_urls=1")," is passed to a feed URL (which the framework does automatically). The following is the default rewrite rule set by the framework in Next.js:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"{\n source: `${prefix}/feed`,\n destination: `${wpUrl}/feed/?rewrite_urls=1`,\n},\n")),(0,o.kt)("p",null,"Therefore, accessing the feed from your WordPress domain will display the WP URLs unless you pass ",(0,o.kt)("inlineCode",{parentName:"p"},"?rewrite_urls=1"),"."),(0,o.kt)("h2",{id:"filtering-when-to-rewrite-urls"},"Filtering when to rewrite URLs"),(0,o.kt)("p",null,"If you want to better control when feed URLs are rewritten there's a filter called ",(0,o.kt)("inlineCode",{parentName:"p"},"tenup_headless_wp_should_rewrite_feed_urls"),"."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-php"},"/**\n * Filter's out whether feed urls should be rewritten\n *\n * @param boolean $rewrite_urls Whether the current request should rewrite_urls\n */\nreturn apply_filters( 'tenup_headless_wp_should_rewrite_feed_urls', (bool) $rewrite_urls );\n")),(0,o.kt)("p",null,"You could use this to always enable rewriting the feed URLs or to use a different query param to enable URL rewrites in the feed."))}p.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[2179],{3905:(e,t,r)=>{r.d(t,{Zo:()=>u,kt:()=>h});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function s(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var l=n.createContext({}),d=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},u=function(e){var t=d(e.components);return n.createElement(l.Provider,{value:t},e.children)},p="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},f=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,l=e.parentName,u=i(e,["components","mdxType","originalType","parentName"]),p=d(r),f=o,h=p["".concat(l,".").concat(f)]||p[f]||c[f]||a;return r?n.createElement(h,s(s({ref:t},u),{},{components:r})):n.createElement(h,s({ref:t},u))}));function h(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,s=new Array(a);s[0]=f;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[p]="string"==typeof e?e:o,s[1]=i;for(var d=2;d{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>p,frontMatter:()=>a,metadata:()=>i,toc:()=>d});var n=r(7462),o=(r(7294),r(3905));const a={slug:"/wordpress-integration/feeds"},s="Feeds",i={unversionedId:"WordPress Integration/feeds",id:"WordPress Integration/feeds",title:"Feeds",description:"Feeds are proxied via Next.js rewrites by default. meaning that you can directly access the feed via your front-end/Next.js URL.",source:"@site/documentation/06-WordPress Integration/feeds.md",sourceDirName:"06-WordPress Integration",slug:"/wordpress-integration/feeds",permalink:"/docs/learn/wordpress-integration/feeds",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/06-WordPress Integration/feeds.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",frontMatter:{slug:"/wordpress-integration/feeds"},sidebar:"tutorialSidebar",previous:{title:"Basic Auth",permalink:"/docs/learn/wordpress-integration/basic-auth"},next:{title:"Gutenberg",permalink:"/docs/learn/wordpress-integration/gutenberg"}},l={},d=[{value:"Filtering when to rewrite URLs",id:"filtering-when-to-rewrite-urls",level:2}],u={toc:d};function p(e){let{components:t,...r}=e;return(0,o.kt)("wrapper",(0,n.Z)({},u,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"feeds"},"Feeds"),(0,o.kt)("p",null,"Feeds are proxied via Next.js rewrites by default. meaning that you can directly access the feed via your front-end/Next.js URL."),(0,o.kt)("p",null,"If you have the plugin enabled, the URLs in the feed will also be rewritten to use front-end URLs. URLs are only rewritten if ",(0,o.kt)("inlineCode",{parentName:"p"},"?rewrite_urls=1")," is passed to a feed URL (which the framework does automatically). The following is the default rewrite rule set by the framework in Next.js:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"{\n source: `${prefix}/feed`,\n destination: `${wpUrl}/feed/?rewrite_urls=1`,\n},\n")),(0,o.kt)("p",null,"Therefore, accessing the feed from your WordPress domain will display the WP URLs unless you pass ",(0,o.kt)("inlineCode",{parentName:"p"},"?rewrite_urls=1"),"."),(0,o.kt)("h2",{id:"filtering-when-to-rewrite-urls"},"Filtering when to rewrite URLs"),(0,o.kt)("p",null,"If you want to better control when feed URLs are rewritten there's a filter called ",(0,o.kt)("inlineCode",{parentName:"p"},"tenup_headless_wp_should_rewrite_feed_urls"),"."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-php"},"/**\n * Filter's out whether feed urls should be rewritten\n *\n * @param boolean $rewrite_urls Whether the current request should rewrite_urls\n */\nreturn apply_filters( 'tenup_headless_wp_should_rewrite_feed_urls', (bool) $rewrite_urls );\n")),(0,o.kt)("p",null,"You could use this to always enable rewriting the feed URLs or to use a different query param to enable URL rewrites in the feed."))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/fb675763.1a1dd200.js b/assets/js/fb675763.0306115d.js similarity index 98% rename from assets/js/fb675763.1a1dd200.js rename to assets/js/fb675763.0306115d.js index 1ab6862d6..eec7d4db3 100644 --- a/assets/js/fb675763.1a1dd200.js +++ b/assets/js/fb675763.0306115d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7067],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>k});var o=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var c=o.createContext({}),i=function(e){var t=o.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},p=function(e){var t=i(e.components);return o.createElement(c.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},h=o.forwardRef((function(e,t){var n=e.components,r=e.mdxType,a=e.originalType,c=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),d=i(n),h=r,k=d["".concat(c,".").concat(h)]||d[h]||u[h]||a;return n?o.createElement(k,s(s({ref:t},p),{},{components:n})):o.createElement(k,s({ref:t},p))}));function k(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var a=n.length,s=new Array(a);s[0]=h;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l[d]="string"==typeof e?e:r,s[1]=l;for(var i=2;i{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>d,frontMatter:()=>a,metadata:()=>l,toc:()=>i});var o=n(7462),r=(n(7294),n(3905));const a={sidebar_label:"Rendering Blocks",sidebar_position:0,slug:"/gutenberg/rendering-blocks"},s="Rendering Blocks",l={unversionedId:"Gutenberg/rendering-blocks",id:"Gutenberg/rendering-blocks",title:"Rendering Blocks",description:"Introduction",source:"@site/documentation/05-Gutenberg/rendering-blocks.md",sourceDirName:"05-Gutenberg",slug:"/gutenberg/rendering-blocks",permalink:"/docs/learn/gutenberg/rendering-blocks",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/05-Gutenberg/rendering-blocks.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1710434842,formattedLastUpdatedAt:"Mar 14, 2024",sidebarPosition:0,frontMatter:{sidebar_label:"Rendering Blocks",sidebar_position:0,slug:"/gutenberg/rendering-blocks"},sidebar:"tutorialSidebar",previous:{title:"Escaping & Sanitization",permalink:"/docs/learn/utilities/sanitization"},next:{title:"Rendering Custom Blocks",permalink:"/docs/learn/gutenberg/rendering-custom-blocks"}},c={},i=[{value:"Introduction",id:"introduction",level:2},{value:"Naive Approach",id:"naive-approach",level:3},{value:"Blocks as JSON Approach",id:"blocks-as-json-approach",level:3},{value:"Blocks as Markup Approach",id:"blocks-as-markup-approach",level:3},{value:"Which approach should you use?",id:"which-approach-should-you-use",level:3},{value:"The BlocksRenderer component",id:"the-blocksrenderer-component",level:2},{value:"Matching blocks with isBlock",id:"matching-blocks-with-isblock",level:3},{value:"Matching Blocks with isBlockByName",id:"matching-blocks-with-isblockbyname",level:3},{value:"Core Blocks",id:"core-blocks",level:2}],p={toc:i};function d(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,o.Z)({},p,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"rendering-blocks"},"Rendering Blocks"),(0,r.kt)("h2",{id:"introduction"},"Introduction"),(0,r.kt)("p",null,"There are multiple approaches to block rendering"),(0,r.kt)("h3",{id:"naive-approach"},"Naive Approach"),(0,r.kt)("p",null,'Simply output the generated markup "as is", using dangerouslySetInnerHTML.'),(0,r.kt)("h3",{id:"blocks-as-json-approach"},"Blocks as JSON Approach"),(0,r.kt)("p",null,"With this approach, there's some custom PHP logic that parses blocks on the PHP side of things and converts them to JSON to be included in the REST API (or GraphQL). "),(0,r.kt)("p",null,"This approach makes it very easy (and portable) to render blocks anywhere, but on the other hand, it forces the implementation of all supported blocks. Handling server-rendered blocks is also a problem."),(0,r.kt)("p",null,"In this approach, blocks are parsed on the Backend."),(0,r.kt)("h3",{id:"blocks-as-markup-approach"},"Blocks as Markup Approach"),(0,r.kt)("p",null,"Instead of simply outputting the generated markup \u201cas is\u201d, it runs the block markup through an HTML parser (after sanitizing) and selectively (and progressively) replaces block markup with actual React components as needed."),(0,r.kt)("p",null,"This approach is the simplest way to render blocks as not all blocks need to be actual React components (e.g paragraphs, lists, etc). You only need to create React Components for very specific blocks such as Links, Images, and \u201cdynamic blocks\u201d such as accordion, etc. You can still ignore certain blocks if you want better control of supported blocks (both on the WP side and the front-end side)."),(0,r.kt)("p",null,"In this approach, blocks are parsed on the Frontend."),(0,r.kt)("h3",{id:"which-approach-should-you-use"},"Which approach should you use?"),(0,r.kt)("p",null,"The framework supports all of these approaches. However, it does not ship with a \u201cblocks-to-rest\u201d plugin. But nothing is stopping you from shipping your own."),(0,r.kt)("p",null,"Instead, it provides a React API for selectively choosing blocks to be replaced with React components and as we\u2019ll show in this article this approach works well for most content-focused websites and can even be implemented in React Native apps to power App screens fully curated by Gutenberg."),(0,r.kt)("h2",{id:"the-blocksrenderer-component"},"The BlocksRenderer component"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"BlocksRenderer")," component is the heart of the \u201cHTML to React\u201d approach. It receives arbitrary HTML markup, runs its content through wpKsesPost, and replaces markup with react component based on the child components passed to it. This approach is not tied to Gutenberg markup in any way, it can be used as a generic HTML-to-React conversion tool. Here\u2019s a simple example of how it works"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},'const MyLinkBlock = ({ domNode, children }) => {\n // get the html attributes from the dom node\n const { href, rel } = domNode.attribs;\n\n return (\n \n {children}\n \n );\n};\n\nexport const Blocks = ({ html }) => {\n return (\n \n \n \n );\n};\n')),(0,r.kt)("p",null,"In the example above, we\u2019re passing the HTML content directly to BlocksRenderer and we\u2019re specifying that any anchor tags with a class of \u201cmy-special-anchor\u201d should be replaced with MyLinkBlock."),(0,r.kt)("p",null,"The MyLinkBlock then gets one special prop called domNode which is the DOM Node that\u2019s being replaced with a React component. You can use domNode to access attributes of the node such as href and rel in this case."),(0,r.kt)("p",null,"Alternatively, you can also specify a test function to match dom nodes, the example above could also have been written as shown below"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"}," node.type === 'tag' \n && node.name === 'a' \n && node.attribs.class === 'my-special-anchor'\n } \n/>\n")),(0,r.kt)("p",null,"There are a number of utility functions that make matching nodes and blocks specifically very easy as we\u2019ll see now."),(0,r.kt)("h3",{id:"matching-blocks-with-isblock"},"Matching blocks with isBlock"),(0,r.kt)("p",null,"The isBlock function matches a DOM node by its tagName and optionally CSS classes."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"\n isBlock(node, { tagName: 'div', classList: ['block-class-name'] })}\n />\n\n")),(0,r.kt)("h3",{id:"matching-blocks-with-isblockbyname"},"Matching Blocks with isBlockByName"),(0,r.kt)("p",null,"The isBlockByName matches a DOM node by its Gutenberg block name. This function requires the HeadstartWP plugin. The plugin appends two special attributes to every block: ",(0,r.kt)("inlineCode",{parentName:"p"},"data-wp-block-name")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"data-wp-block-attrs"),"."),(0,r.kt)("p",null,"This is a very handy function as it makes it very easy to match any registered Gutenberg block."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"\n isBlock(node, 'core/paragraph')}\n />\n\n")),(0,r.kt)("h2",{id:"core-blocks"},"Core Blocks"),(0,r.kt)("p",null,"Not all core blocks would need to be rendered as React components, but when needed to replace core blocks with react components, the framework provides a set of components that does the heavy lifting of matching core blocks and getting their properties. This set of blocks can be seen here."),(0,r.kt)("p",null,"You can explore how this works by using a debug block component to inspect all of its props. "),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"import {\n BlocksRenderer,\n YoutubeLiteBlock,\n ImageBlock,\n ColumnBlock,\n ColumnsBlock,\n ParagraphBlock,\n DebugBlock,\n} from '@headstartwp/core/react';\n\n\n { /* .... */ }\n \n \n \n\n")),(0,r.kt)("p",null,"You should see something like this\n",(0,r.kt)("img",{alt:"Debug Blocks",src:n(1546).Z,width:"1024",height:"669"})),(0,r.kt)("p",null,"By inspecting the props you can see you have access to things like block name, className, and even the Gutenberg attributes. You could, in theory, build your implementation for every block without loading any of the default Gutenberg styles, shipping your own component library/design system."))}d.isMDXComponent=!0},1546:(e,t,n)=>{n.d(t,{Z:()=>o});const o=n.p+"assets/images/debug-blocks-bcbca3b384a5e56495b121ea85ba5401.png"}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[7067],{3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>k});var o=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var c=o.createContext({}),i=function(e){var t=o.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},p=function(e){var t=i(e.components);return o.createElement(c.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},h=o.forwardRef((function(e,t){var n=e.components,r=e.mdxType,a=e.originalType,c=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),d=i(n),h=r,k=d["".concat(c,".").concat(h)]||d[h]||u[h]||a;return n?o.createElement(k,s(s({ref:t},p),{},{components:n})):o.createElement(k,s({ref:t},p))}));function k(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var a=n.length,s=new Array(a);s[0]=h;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l[d]="string"==typeof e?e:r,s[1]=l;for(var i=2;i{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>s,default:()=>d,frontMatter:()=>a,metadata:()=>l,toc:()=>i});var o=n(7462),r=(n(7294),n(3905));const a={sidebar_label:"Rendering Blocks",sidebar_position:0,slug:"/gutenberg/rendering-blocks"},s="Rendering Blocks",l={unversionedId:"Gutenberg/rendering-blocks",id:"Gutenberg/rendering-blocks",title:"Rendering Blocks",description:"Introduction",source:"@site/documentation/05-Gutenberg/rendering-blocks.md",sourceDirName:"05-Gutenberg",slug:"/gutenberg/rendering-blocks",permalink:"/docs/learn/gutenberg/rendering-blocks",draft:!1,editUrl:"https://github.com/10up/headstartwp/tree/trunk/docs/documentation/05-Gutenberg/rendering-blocks.md",tags:[],version:"current",lastUpdatedBy:"N\xedcholas Andr\xe9",lastUpdatedAt:1711056142,formattedLastUpdatedAt:"Mar 21, 2024",sidebarPosition:0,frontMatter:{sidebar_label:"Rendering Blocks",sidebar_position:0,slug:"/gutenberg/rendering-blocks"},sidebar:"tutorialSidebar",previous:{title:"Escaping & Sanitization",permalink:"/docs/learn/utilities/sanitization"},next:{title:"Rendering Custom Blocks",permalink:"/docs/learn/gutenberg/rendering-custom-blocks"}},c={},i=[{value:"Introduction",id:"introduction",level:2},{value:"Naive Approach",id:"naive-approach",level:3},{value:"Blocks as JSON Approach",id:"blocks-as-json-approach",level:3},{value:"Blocks as Markup Approach",id:"blocks-as-markup-approach",level:3},{value:"Which approach should you use?",id:"which-approach-should-you-use",level:3},{value:"The BlocksRenderer component",id:"the-blocksrenderer-component",level:2},{value:"Matching blocks with isBlock",id:"matching-blocks-with-isblock",level:3},{value:"Matching Blocks with isBlockByName",id:"matching-blocks-with-isblockbyname",level:3},{value:"Core Blocks",id:"core-blocks",level:2}],p={toc:i};function d(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,o.Z)({},p,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"rendering-blocks"},"Rendering Blocks"),(0,r.kt)("h2",{id:"introduction"},"Introduction"),(0,r.kt)("p",null,"There are multiple approaches to block rendering"),(0,r.kt)("h3",{id:"naive-approach"},"Naive Approach"),(0,r.kt)("p",null,'Simply output the generated markup "as is", using dangerouslySetInnerHTML.'),(0,r.kt)("h3",{id:"blocks-as-json-approach"},"Blocks as JSON Approach"),(0,r.kt)("p",null,"With this approach, there's some custom PHP logic that parses blocks on the PHP side of things and converts them to JSON to be included in the REST API (or GraphQL). "),(0,r.kt)("p",null,"This approach makes it very easy (and portable) to render blocks anywhere, but on the other hand, it forces the implementation of all supported blocks. Handling server-rendered blocks is also a problem."),(0,r.kt)("p",null,"In this approach, blocks are parsed on the Backend."),(0,r.kt)("h3",{id:"blocks-as-markup-approach"},"Blocks as Markup Approach"),(0,r.kt)("p",null,"Instead of simply outputting the generated markup \u201cas is\u201d, it runs the block markup through an HTML parser (after sanitizing) and selectively (and progressively) replaces block markup with actual React components as needed."),(0,r.kt)("p",null,"This approach is the simplest way to render blocks as not all blocks need to be actual React components (e.g paragraphs, lists, etc). You only need to create React Components for very specific blocks such as Links, Images, and \u201cdynamic blocks\u201d such as accordion, etc. You can still ignore certain blocks if you want better control of supported blocks (both on the WP side and the front-end side)."),(0,r.kt)("p",null,"In this approach, blocks are parsed on the Frontend."),(0,r.kt)("h3",{id:"which-approach-should-you-use"},"Which approach should you use?"),(0,r.kt)("p",null,"The framework supports all of these approaches. However, it does not ship with a \u201cblocks-to-rest\u201d plugin. But nothing is stopping you from shipping your own."),(0,r.kt)("p",null,"Instead, it provides a React API for selectively choosing blocks to be replaced with React components and as we\u2019ll show in this article this approach works well for most content-focused websites and can even be implemented in React Native apps to power App screens fully curated by Gutenberg."),(0,r.kt)("h2",{id:"the-blocksrenderer-component"},"The BlocksRenderer component"),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"BlocksRenderer")," component is the heart of the \u201cHTML to React\u201d approach. It receives arbitrary HTML markup, runs its content through wpKsesPost, and replaces markup with react component based on the child components passed to it. This approach is not tied to Gutenberg markup in any way, it can be used as a generic HTML-to-React conversion tool. Here\u2019s a simple example of how it works"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},'const MyLinkBlock = ({ domNode, children }) => {\n // get the html attributes from the dom node\n const { href, rel } = domNode.attribs;\n\n return (\n \n {children}\n \n );\n};\n\nexport const Blocks = ({ html }) => {\n return (\n \n \n \n );\n};\n')),(0,r.kt)("p",null,"In the example above, we\u2019re passing the HTML content directly to BlocksRenderer and we\u2019re specifying that any anchor tags with a class of \u201cmy-special-anchor\u201d should be replaced with MyLinkBlock."),(0,r.kt)("p",null,"The MyLinkBlock then gets one special prop called domNode which is the DOM Node that\u2019s being replaced with a React component. You can use domNode to access attributes of the node such as href and rel in this case."),(0,r.kt)("p",null,"Alternatively, you can also specify a test function to match dom nodes, the example above could also have been written as shown below"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"}," node.type === 'tag' \n && node.name === 'a' \n && node.attribs.class === 'my-special-anchor'\n } \n/>\n")),(0,r.kt)("p",null,"There are a number of utility functions that make matching nodes and blocks specifically very easy as we\u2019ll see now."),(0,r.kt)("h3",{id:"matching-blocks-with-isblock"},"Matching blocks with isBlock"),(0,r.kt)("p",null,"The isBlock function matches a DOM node by its tagName and optionally CSS classes."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"\n isBlock(node, { tagName: 'div', classList: ['block-class-name'] })}\n />\n\n")),(0,r.kt)("h3",{id:"matching-blocks-with-isblockbyname"},"Matching Blocks with isBlockByName"),(0,r.kt)("p",null,"The isBlockByName matches a DOM node by its Gutenberg block name. This function requires the HeadstartWP plugin. The plugin appends two special attributes to every block: ",(0,r.kt)("inlineCode",{parentName:"p"},"data-wp-block-name")," and ",(0,r.kt)("inlineCode",{parentName:"p"},"data-wp-block-attrs"),"."),(0,r.kt)("p",null,"This is a very handy function as it makes it very easy to match any registered Gutenberg block."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"\n isBlock(node, 'core/paragraph')}\n />\n\n")),(0,r.kt)("h2",{id:"core-blocks"},"Core Blocks"),(0,r.kt)("p",null,"Not all core blocks would need to be rendered as React components, but when needed to replace core blocks with react components, the framework provides a set of components that does the heavy lifting of matching core blocks and getting their properties. This set of blocks can be seen here."),(0,r.kt)("p",null,"You can explore how this works by using a debug block component to inspect all of its props. "),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-js"},"import {\n BlocksRenderer,\n YoutubeLiteBlock,\n ImageBlock,\n ColumnBlock,\n ColumnsBlock,\n ParagraphBlock,\n DebugBlock,\n} from '@headstartwp/core/react';\n\n\n { /* .... */ }\n \n \n \n\n")),(0,r.kt)("p",null,"You should see something like this\n",(0,r.kt)("img",{alt:"Debug Blocks",src:n(1546).Z,width:"1024",height:"669"})),(0,r.kt)("p",null,"By inspecting the props you can see you have access to things like block name, className, and even the Gutenberg attributes. You could, in theory, build your implementation for every block without loading any of the default Gutenberg styles, shipping your own component library/design system."))}d.isMDXComponent=!0},1546:(e,t,n)=>{n.d(t,{Z:()=>o});const o=n.p+"assets/images/debug-blocks-bcbca3b384a5e56495b121ea85ba5401.png"}}]); \ No newline at end of file diff --git a/assets/js/fd4b5c92.b059dcb7.js b/assets/js/fd4b5c92.a7342a98.js similarity index 96% rename from assets/js/fd4b5c92.b059dcb7.js rename to assets/js/fd4b5c92.a7342a98.js index d0727ca87..781942855 100644 --- a/assets/js/fd4b5c92.b059dcb7.js +++ b/assets/js/fd4b5c92.a7342a98.js @@ -1 +1 @@ -"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5123],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),d=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},c=function(e){var t=d(e.components);return r.createElement(o.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),s=d(a),m=n,h=s["".concat(o,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},c),{},{components:a})):r.createElement(h,l({ref:t},c))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[s]="string"==typeof e?e:n,l[1]=p;for(var d=2;d{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>p,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.GroupBlockProps",title:"Interface: GroupBlockProps",sidebar_label:"@headstartwp/core.react.GroupBlockProps",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.react.GroupBlockProps",id:"interfaces/headstartwp_core.react.GroupBlockProps",title:"Interface: GroupBlockProps",description:"@headstartwp/core.react.GroupBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.GroupBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.GroupBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.GroupBlockProps",title:"Interface: GroupBlockProps",sidebar_label:"@headstartwp/core.react.GroupBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.FileBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps"},next:{title:"@headstartwp/core.react.GutenbergBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.GutenbergBlockProps"}},o={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"layout",id:"layout",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"tagName",id:"tagname",level:3},{value:"Defined in",id:"defined-in-8",level:4}],c={toc:d};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".GroupBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"GroupBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"layout"},"layout"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"layout"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"allowOrientation?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"justifyContent?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},'"center"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},'"left"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},'"right"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},'"space-between"'))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"type?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/GroupBlock.tsx#L8"},"packages/core/src/react/blocks/GroupBlock.tsx:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/ccdbd9d/packages/core/src/react/blocks/GroupBlock.tsx#L7"},"packages/core/src/react/blocks/GroupBlock.tsx:7")))}s.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[5123],{3905:(e,t,a)=>{a.d(t,{Zo:()=>c,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function l(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var o=r.createContext({}),d=function(e){var t=r.useContext(o),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},c=function(e){var t=d(e.components);return r.createElement(o.Provider,{value:t},e.children)},s="mdxType",k={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),s=d(a),m=n,h=s["".concat(o,".").concat(m)]||s[m]||k[m]||i;return a?r.createElement(h,l(l({ref:t},c),{},{components:a})):r.createElement(h,l({ref:t},c))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=a.length,l=new Array(i);l[0]=m;var p={};for(var o in t)hasOwnProperty.call(t,o)&&(p[o]=t[o]);p.originalType=e,p[s]="string"==typeof e?e:n,l[1]=p;for(var d=2;d{a.r(t),a.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>s,frontMatter:()=>i,metadata:()=>p,toc:()=>d});var r=a(7462),n=(a(7294),a(3905));const i={id:"headstartwp_core.react.GroupBlockProps",title:"Interface: GroupBlockProps",sidebar_label:"@headstartwp/core.react.GroupBlockProps",custom_edit_url:null},l=void 0,p={unversionedId:"interfaces/headstartwp_core.react.GroupBlockProps",id:"interfaces/headstartwp_core.react.GroupBlockProps",title:"Interface: GroupBlockProps",description:"@headstartwp/core.react.GroupBlockProps",source:"@site/docs/interfaces/headstartwp_core.react.GroupBlockProps.md",sourceDirName:"interfaces",slug:"/interfaces/headstartwp_core.react.GroupBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"headstartwp_core.react.GroupBlockProps",title:"Interface: GroupBlockProps",sidebar_label:"@headstartwp/core.react.GroupBlockProps",custom_edit_url:null},sidebar:"tutorialSidebar",previous:{title:"@headstartwp/core.react.FileBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps"},next:{title:"@headstartwp/core.react.GutenbergBlockProps",permalink:"/docs/api/interfaces/headstartwp_core.react.GutenbergBlockProps"}},o={},d=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Properties",id:"properties",level:2},{value:"attributes",id:"attributes",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"children",id:"children",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"className",id:"classname",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"domNode",id:"domnode",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"htmlAnchor",id:"htmlanchor",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"layout",id:"layout",level:3},{value:"Type declaration",id:"type-declaration-1",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"style",id:"style",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"tagName",id:"tagname",level:3},{value:"Defined in",id:"defined-in-8",level:4}],c={toc:d};function s(e){let{components:t,...a}=e;return(0,n.kt)("wrapper",(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/modules/headstartwp_core"},"@headstartwp/core"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/namespaces/headstartwp_core.react"},"react"),".GroupBlockProps"),(0,n.kt)("h2",{id:"hierarchy"},"Hierarchy"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},(0,n.kt)("inlineCode",{parentName:"a"},"IBlockAttributes"))),(0,n.kt)("p",{parentName:"li"},"\u21b3 ",(0,n.kt)("strong",{parentName:"p"},(0,n.kt)("inlineCode",{parentName:"strong"},"GroupBlockProps"))))),(0,n.kt)("h2",{id:"properties"},"Properties"),(0,n.kt)("h3",{id:"attributes"},"attributes"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"attributes"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"align")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#align"},(0,n.kt)("inlineCode",{parentName:"a"},"Align")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"blockStyle?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"border")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#border"},(0,n.kt)("inlineCode",{parentName:"a"},"Border")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"colors")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Colors"},(0,n.kt)("inlineCode",{parentName:"a"},"Colors")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"spacing")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/namespaces/headstartwp_core.react#spacing"},(0,n.kt)("inlineCode",{parentName:"a"},"Spacing")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"typography")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("a",{parentName:"td",href:"/docs/api/interfaces/headstartwp_core.react.Typography"},(0,n.kt)("inlineCode",{parentName:"a"},"Typography")))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"width?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"inherited-from"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#attributes"},"attributes")),(0,n.kt)("h4",{id:"defined-in"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L79"},"packages/core/src/react/blocks/types.ts:79")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"children"},"children"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"children"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"ReactNode")),(0,n.kt)("h4",{id:"inherited-from-1"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#children"},"children")),(0,n.kt)("h4",{id:"defined-in-1"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L77"},"packages/core/src/react/blocks/types.ts:77")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"classname"},"className"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"className"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-2"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#classname"},"className")),(0,n.kt)("h4",{id:"defined-in-2"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L73"},"packages/core/src/react/blocks/types.ts:73")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"domnode"},"domNode"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"domNode"),": ",(0,n.kt)("a",{parentName:"p",href:"/docs/api/classes/headstartwp_core.Element"},(0,n.kt)("inlineCode",{parentName:"a"},"Element"))),(0,n.kt)("h4",{id:"inherited-from-3"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#domnode"},"domNode")),(0,n.kt)("h4",{id:"defined-in-3"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L75"},"packages/core/src/react/blocks/types.ts:75")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"htmlanchor"},"htmlAnchor"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"htmlAnchor"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-4"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#htmlanchor"},"htmlAnchor")),(0,n.kt)("h4",{id:"defined-in-4"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L76"},"packages/core/src/react/blocks/types.ts:76")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"layout"},"layout"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"layout"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Object")),(0,n.kt)("h4",{id:"type-declaration-1"},"Type declaration"),(0,n.kt)("table",null,(0,n.kt)("thead",{parentName:"table"},(0,n.kt)("tr",{parentName:"thead"},(0,n.kt)("th",{parentName:"tr",align:"left"},"Name"),(0,n.kt)("th",{parentName:"tr",align:"left"},"Type"))),(0,n.kt)("tbody",{parentName:"table"},(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"allowOrientation?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"boolean"))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"justifyContent?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},'"center"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},'"left"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},'"right"')," ","|"," ",(0,n.kt)("inlineCode",{parentName:"td"},'"space-between"'))),(0,n.kt)("tr",{parentName:"tbody"},(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"type?")),(0,n.kt)("td",{parentName:"tr",align:"left"},(0,n.kt)("inlineCode",{parentName:"td"},"string"))))),(0,n.kt)("h4",{id:"defined-in-5"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/GroupBlock.tsx#L8"},"packages/core/src/react/blocks/GroupBlock.tsx:8")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"name"},"name"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("strong",{parentName:"p"},"name"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"inherited-from-5"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#name"},"name")),(0,n.kt)("h4",{id:"defined-in-6"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L72"},"packages/core/src/react/blocks/types.ts:72")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"style"},"style"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"style"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"Record"),"<",(0,n.kt)("inlineCode",{parentName:"p"},"string"),", ",(0,n.kt)("inlineCode",{parentName:"p"},"string"),">"),(0,n.kt)("h4",{id:"inherited-from-6"},"Inherited from"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes"},"IBlockAttributes"),".",(0,n.kt)("a",{parentName:"p",href:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes#style"},"style")),(0,n.kt)("h4",{id:"defined-in-7"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/types.ts#L74"},"packages/core/src/react/blocks/types.ts:74")),(0,n.kt)("hr",null),(0,n.kt)("h3",{id:"tagname"},"tagName"),(0,n.kt)("p",null,"\u2022 ",(0,n.kt)("inlineCode",{parentName:"p"},"Optional")," ",(0,n.kt)("strong",{parentName:"p"},"tagName"),": ",(0,n.kt)("inlineCode",{parentName:"p"},"string")),(0,n.kt)("h4",{id:"defined-in-8"},"Defined in"),(0,n.kt)("p",null,(0,n.kt)("a",{parentName:"p",href:"https://github.com/10up/headstartwp/blob/9a3d714/packages/core/src/react/blocks/GroupBlock.tsx#L7"},"packages/core/src/react/blocks/GroupBlock.tsx:7")))}s.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/main.aee4b059.js b/assets/js/main.aee4b059.js deleted file mode 100644 index bd23bf1a4..000000000 --- a/assets/js/main.aee4b059.js +++ /dev/null @@ -1,2 +0,0 @@ -/*! For license information please see main.aee4b059.js.LICENSE.txt */ -(self.webpackChunkheadless_doc=self.webpackChunkheadless_doc||[]).push([[179],{723:(e,t,n)=>{"use strict";n.d(t,{Z:()=>f});var r=n(7294),a=n(7462),o=n(8356),i=n.n(o),s=n(6887);const c={"0065d4a9":[()=>n.e(3035).then(n.bind(n,5247)),"@site/docs/classes/headstartwp_core.FrameworkError.md",5247],"00a631a6":[()=>n.e(9605).then(n.bind(n,4827)),"@site/documentation/02 - Data Fetching/useTerms.md",4827],"00b96e45":[()=>n.e(4858).then(n.bind(n,5016)),"@site/docs/interfaces/headstartwp_core.react.Colors.md",5016],"01354409":[()=>n.e(3021).then(n.bind(n,3700)),"@site/docs/interfaces/headstartwp_core.AvatarUrls.md",3700],"016f03e8":[()=>n.e(2849).then(n.bind(n,1182)),"@site/documentation/08-Guides/ab-test-link.md",1182],"042474ac":[()=>n.e(669).then(n.bind(n,6001)),"@site/docs/interfaces/headstartwp_core.react.IPreformattedBlock.md",6001],"09026ff1":[()=>n.e(5665).then(n.bind(n,5471)),"@site/docs/interfaces/headstartwp_core.react.HookResponse.md",5471],"09153873":[()=>n.e(3182).then(n.bind(n,584)),"@site/docs/interfaces/headstartwp_core.PostsArchiveParams.md",584],"0a88c552":[()=>n.e(1701).then(n.bind(n,8179)),"@site/docs/interfaces/headstartwp_core.TaxonomyArchiveParams.md",8179],"0b387740":[()=>n.e(8467).then(n.t.bind(n,9676,19)),"~docs/docs/version-current-metadata-prop-751.json",9676],"0dbccef1":[()=>n.e(2925).then(n.bind(n,2543)),"@site/docs/modules/headstartwp_core.md",2543],"0f4f470d":[()=>n.e(9050).then(n.bind(n,8786)),"@site/docs/interfaces/headstartwp_core.react.PullQuoteBlockProps.md",8786],"0f702274":[()=>n.e(3222).then(n.bind(n,6650)),"@site/docs/classes/headstartwp_core.SearchNativeFetchStrategy.md",6650],"0f7b7d82":[()=>n.e(3533).then(n.bind(n,6310)),"@site/docs/interfaces/headstartwp_core.react.PreformattedBlockProps.md",6310],10176796:[()=>n.e(4470).then(n.bind(n,8323)),"@site/docs/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete.md",8323],"126717b4":[()=>n.e(1247).then(n.bind(n,7515)),"@site/docs/interfaces/headstartwp_core.react.SettingsProperties.md",7515],15509991:[()=>n.e(1425).then(n.bind(n,6265)),"@site/documentation/01-Getting Started/headless-config.md",6265],"173c930b":[()=>n.e(3446).then(n.bind(n,7033)),"@site/documentation/02 - Data Fetching/custom-hooks.md",7033],17896441:[()=>Promise.all([n.e(532),n.e(272),n.e(7918)]).then(n.bind(n,903)),"@theme/DocItem",903],"1937a900":[()=>n.e(3138).then(n.bind(n,7644)),"@site/docs/interfaces/headstartwp_core.react.ColumnBlockProps.md",7644],"19a8a98a":[()=>n.e(4401).then(n.bind(n,4021)),"@site/docs/interfaces/headstartwp_core.react.ListBlockProps.md",4021],"1a4e3797":[()=>Promise.all([n.e(532),n.e(7920)]).then(n.bind(n,2027)),"@theme/SearchPage",2027],"1a87c9a6":[()=>n.e(2507).then(n.bind(n,2618)),"@site/docs/interfaces/headstartwp_core.SearchEntity.md",2618],"1be78505":[()=>Promise.all([n.e(532),n.e(9514)]).then(n.bind(n,9963)),"@theme/DocPage",9963],"1efe64df":[()=>n.e(9410).then(n.bind(n,3908)),"@site/docs/interfaces/headstartwp_core.react.ICodeBlock.md",3908],"1f391b9e":[()=>Promise.all([n.e(532),n.e(272),n.e(3085)]).then(n.bind(n,4247)),"@theme/MDXPage",4247],"1fbe2079":[()=>n.e(2781).then(n.bind(n,5386)),"@site/documentation/06-WordPress Integration/previews.md",5386],"20c672e4":[()=>n.e(2201).then(n.bind(n,2479)),"@site/docs/interfaces/headstartwp_core.react.FetchHookOptions.md",2479],"241565db":[()=>n.e(9210).then(n.bind(n,3282)),"@site/docs/interfaces/headstartwp_core.react.ITableBlock.md",3282],"245007dc":[()=>n.e(1398).then(n.bind(n,5958)),"@site/docs/interfaces/headstartwp_core.react.ParagraphBlockProps.md",5958],"24728c4e":[()=>n.e(1408).then(n.bind(n,5535)),"@site/docs/classes/headstartwp_core.AppSettingsStrategy.md",5535],"2772b305":[()=>n.e(157).then(n.bind(n,2577)),"@site/docs/interfaces/headstartwp_core.react.ImageBlockProps.md",2577],"2cb93857":[()=>n.e(5233).then(n.bind(n,1522)),"@site/docs/classes/headstartwp_core.EndpointError.md",1522],"2e459592":[()=>n.e(3864).then(n.bind(n,792)),"@site/docs/interfaces/headstartwp_core.react.CodeBlockProps.md",792],"2f6d1272":[()=>n.e(5835).then(n.bind(n,2661)),"@site/docs/interfaces/headstartwp_core.PolylangIntegration.md",2661],"2f847acf":[()=>n.e(3333).then(n.bind(n,7615)),"@site/docs/interfaces/headstartwp_core.react.IColumnBlock.md",7615],"30db8841":[()=>n.e(6303).then(n.t.bind(n,2776,19)),"/home/runner/work/headstartwp/headstartwp/docs/.docusaurus/@easyops-cn/docusaurus-search-local/default/plugin-route-context-module-100.json",2776],"312a1558":[()=>n.e(2376).then(n.bind(n,5679)),"@site/docs/interfaces/headstartwp_core.react.IYoutubeLiteBlock.md",5679],"31d83884":[()=>n.e(2960).then(n.bind(n,5779)),"@site/docs/interfaces/headstartwp_core.react.usePostResponse.md",5779],"3416b62b":[()=>n.e(8981).then(n.bind(n,1206)),"@site/docs/classes/headstartwp_core.Comment.md",1206],"35c3fc85":[()=>n.e(9673).then(n.bind(n,2065)),"@site/docs/interfaces/headstartwp_core.TermEntity.md",2065],"361465a4":[()=>n.e(7701).then(n.bind(n,8929)),"@site/docs/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties.md",8929],"37b079cc":[()=>n.e(7307).then(n.bind(n,5956)),"@site/docs/interfaces/headstartwp_core.react.IAudioBlock.md",5956],"37bc9424":[()=>n.e(631).then(n.bind(n,7087)),"@site/docs/interfaces/headstartwp_core.react.useSearchNativeResponse.md",7087],"37d12b40":[()=>n.e(26).then(n.bind(n,4e3)),"@site/docs/interfaces/headstartwp_core.react.useTermsResponse.md",4e3],"37ef8e6f":[()=>n.e(228).then(n.bind(n,8190)),"@site/docs/interfaces/headstartwp_next.ImageProps.md",8190],"38f0e7b9":[()=>n.e(2254).then(n.bind(n,1942)),"@site/docs/classes/headstartwp_core.SinglePostFetchStrategy.md",1942],"3adfa64f":[()=>n.e(9379).then(n.t.bind(n,5745,19)),"/home/runner/work/headstartwp/headstartwp/docs/.docusaurus/docusaurus-plugin-content-pages/default/plugin-route-context-module-100.json",5745],"3b216a90":[()=>n.e(8989).then(n.bind(n,2108)),"@site/documentation/01-Getting Started/quick-tutorial.md",2108],"3d28897f":[()=>n.e(1552).then(n.bind(n,4363)),"@site/docs/interfaces/headstartwp_core.react.Typography.md",4363],"44b9bd65":[()=>n.e(3126).then(n.bind(n,8680)),"@site/docs/modules/headstartwp_next.md",8680],"46c017ad":[()=>n.e(2398).then(n.bind(n,1188)),"@site/docs/namespaces/headstartwp_core.react.md",1188],"4727697a":[()=>n.e(2354).then(n.bind(n,7346)),"@site/docs/interfaces/headstartwp_core.RevisionEntity.md",7346],"4917042f":[()=>n.e(6217).then(n.bind(n,698)),"@site/docs/interfaces/headstartwp_core.VerifyTokenParams.md",698],"499cbdae":[()=>n.e(2089).then(n.bind(n,3543)),"@site/documentation/08-Guides/typescript.md",3543],"49db3b24":[()=>n.e(5281).then(n.bind(n,8859)),"@site/docs/interfaces/headstartwp_core.react.ButtonBlockProps.md",8859],"4a0d0a3d":[()=>n.e(8950).then(n.bind(n,8534)),"@site/docs/interfaces/headstartwp_core.react.YoutubeLiteBlockProps.md",8534],"4a5e8971":[()=>n.e(5534).then(n.bind(n,2286)),"@site/docs/interfaces/headstartwp_core.react.IBlockAttributes.md",2286],"4bbbe9cb":[()=>n.e(8327).then(n.bind(n,6061)),"@site/docs/interfaces/headstartwp_core.react.IGroupBlock.md",6061],"4bc3bdcd":[()=>n.e(9921).then(n.bind(n,1489)),"@site/docs/interfaces/headstartwp_core.EndpointParams.md",1489],"4bfc8e71":[()=>n.e(4015).then(n.bind(n,3038)),"@site/documentation/01-Getting Started/wordpress-plugin.md",3038],"4c2ded29":[()=>n.e(3955).then(n.bind(n,6952)),"@site/docs/classes/headstartwp_core.AbstractFetchStrategy.md",6952],"4e3c32b5":[()=>n.e(9530).then(n.bind(n,540)),"@site/documentation/02 - Data Fetching/usePost.md",540],"4e62b870":[()=>n.e(5700).then(n.bind(n,1293)),"@site/docs/interfaces/headstartwp_core.react.IFileBlock.md",1293],"4e86766f":[()=>n.e(6741).then(n.bind(n,9562)),"@site/docs/interfaces/headstartwp_core.react.BlockProps.md",9562],"4ef87eef":[()=>n.e(3178).then(n.bind(n,8609)),"@site/docs/interfaces/headstartwp_core.SearchObjectEntity.md",8609],"4f5f8bb8":[()=>n.e(8526).then(n.bind(n,493)),"@site/docs/interfaces/headstartwp_core.HTMLReactParserOptions.md",493],"54355d51":[()=>n.e(4409).then(n.bind(n,8423)),"@site/docs/interfaces/headstartwp_core.react.IParagraphBlock.md",8423],"54d19cbf":[()=>n.e(825).then(n.bind(n,147)),"@site/documentation/06-WordPress Integration/revalidate.md",147],"55dad7f7":[()=>n.e(3586).then(n.bind(n,3285)),"@site/documentation/03- Utilities/sanitization.md",3285],"560f4e5a":[()=>n.e(8247).then(n.bind(n,8975)),"@site/docs/classes/headstartwp_core.ConfigError.md",8975],"5667ca25":[()=>n.e(1994).then(n.bind(n,2385)),"@site/docs/interfaces/headstartwp_core.AttachmentEntity.md",2385],"58adf8aa":[()=>n.e(3133).then(n.bind(n,7670)),"@site/documentation/05-Gutenberg/rendering-custom-blocks.md",7670],"58e6d968":[()=>n.e(223).then(n.bind(n,1745)),"@site/docs/interfaces/headstartwp_core.SearchParams.md",1745],"5a4180a9":[()=>n.e(9589).then(n.bind(n,5549)),"@site/documentation/01-Getting Started/quick-setup.md",5549],"5bda4233":[()=>n.e(6815).then(n.bind(n,9796)),"@site/docs/interfaces/headstartwp_core.PostEntity.md",9796],"5c59fa4a":[()=>n.e(4192).then(n.bind(n,2444)),"@site/docs/interfaces/headstartwp_core.PostSearchEntity.md",2444],"5e4e234e":[()=>n.e(8596).then(n.bind(n,7558)),"@site/docs/interfaces/headstartwp_core.FetchOptions.md",7558],"5e9f5e1a":[()=>Promise.resolve().then(n.bind(n,6809)),"@generated/docusaurus.config",6809],"5ea6ed43":[()=>n.e(5787).then(n.bind(n,1205)),"@site/docs/interfaces/headstartwp_core.YoastSEOIntegration.md",1205],"5fc1d772":[()=>n.e(5205).then(n.bind(n,2689)),"@site/docs/interfaces/headstartwp_core.react.StylesProperties.md",2689],"604d33cd":[()=>n.e(1627).then(n.bind(n,7559)),"@site/docs/classes/headstartwp_core.Element.md",7559],"637a3551":[()=>n.e(3200).then(n.bind(n,9498)),"@site/docs/interfaces/headstartwp_core.react.VerseBlockProps.md",9498],"66ab7d90":[()=>n.e(520).then(n.bind(n,8877)),"@site/docs/interfaces/headstartwp_core.PostOrPostsParams.md",8877],"66decef0":[()=>n.e(1932).then(n.bind(n,4393)),"@site/docs/interfaces/headstartwp_core.react.IQuoteBlock.md",4393],"670e912d":[()=>n.e(1497).then(n.bind(n,1968)),"@site/documentation/08-Guides/youtube-facade.md",1968],"6e304a43":[()=>n.e(2069).then(n.bind(n,5819)),"@site/docs/interfaces/headstartwp_core.react.ISpacerBlock.md",5819],"6e3e9c68":[()=>n.e(7379).then(n.t.bind(n,3769,19)),"/home/runner/work/headstartwp/headstartwp/docs/.docusaurus/docusaurus-plugin-content-docs/default/plugin-route-context-module-100.json",3769],"6e83ed71":[()=>n.e(1513).then(n.bind(n,3525)),"@site/docs/interfaces/headstartwp_core.AppEntity.md",3525],"6e8d7793":[()=>n.e(7272).then(n.bind(n,2390)),"@site/documentation/02 - Data Fetching/usePostOrPosts.md",2390],"6eeb730f":[()=>n.e(7251).then(n.bind(n,3084)),"@site/docs/classes/headstartwp_core.TaxonomyTermsStrategy.md",3084],"6ef049a8":[()=>n.e(1726).then(n.bind(n,2455)),"@site/docs/interfaces/headstartwp_core.react.AudioBlockProps.md",2455],"704c2a10":[()=>n.e(2779).then(n.bind(n,199)),"@site/docs/interfaces/headstartwp_core.react.HtmlDecodeProps.md",199],"7272e25f":[()=>n.e(7895).then(n.bind(n,5063)),"@site/docs/interfaces/headstartwp_core.react.ButtonsBlockProps.md",5063],"7360f818":[()=>n.e(6875).then(n.bind(n,4032)),"@site/docs/interfaces/headstartwp_core.PageEntity.md",4032],"74bdc397":[()=>n.e(918).then(n.bind(n,1588)),"@site/docs/interfaces/headstartwp_core.react.useSearchResponse.md",1588],"76bd5e23":[()=>n.e(9621).then(n.bind(n,5466)),"@site/docs/interfaces/headstartwp_core.react.IColumnsBlock.md",5466],"7721a5b2":[()=>n.e(5182).then(n.bind(n,288)),"@site/documentation/02 - Data Fetching/usePosts.md",288],"7742af19":[()=>n.e(6494).then(n.bind(n,9653)),"@site/docs/interfaces/headstartwp_core.react.HeadingBlockProps.md",9653],"7844975a":[()=>n.e(4762).then(n.bind(n,8667)),"@site/docs/interfaces/headstartwp_core.react.IListBlock.md",8667],"7d0dd658":[()=>n.e(7246).then(n.bind(n,9840)),"@site/docs/interfaces/headstartwp_core.TaxonomyEntity.md",9840],"7d4fdb35":[()=>n.e(8109).then(n.bind(n,7547)),"@site/docs/interfaces/headstartwp_core.react.QuoteBlockProps.md",7547],"8062ea35":[()=>n.e(7253).then(n.bind(n,7590)),"@site/docs/interfaces/headstartwp_next.LinkBlockProps.md",7590],"8100c8dc":[()=>n.e(4037).then(n.bind(n,8251)),"@site/docs/classes/headstartwp_core.ProcessingInstruction.md",8251],"82691c56":[()=>n.e(3641).then(n.bind(n,9146)),"@site/documentation/02 - Data Fetching/introduction.md",9146],"829b8700":[()=>n.e(2570).then(n.bind(n,198)),"@site/docs/interfaces/headstartwp_core.react.ICoverBlock.md",198],"84bf0742":[()=>n.e(5145).then(n.bind(n,8781)),"@site/docs/interfaces/headstartwp_core.react.BlockRendererProps.md",8781],"8872dee1":[()=>n.e(9638).then(n.bind(n,4204)),"@site/documentation/02 - Data Fetching/useSeo.md",4204],"88a75f53":[()=>n.e(1272).then(n.bind(n,3309)),"@site/docs/interfaces/headstartwp_core.AuthorEntity.md",3309],"90fd0dd1":[()=>n.e(7519).then(n.bind(n,9309)),"@site/docs/interfaces/headstartwp_core.react.FileBlockProps.md",9309],"912e5e58":[()=>n.e(1362).then(n.bind(n,4902)),"@site/docs/interfaces/headstartwp_core.react.SafeHtmlProps.md",4902],"92bb2d44":[()=>n.e(7775).then(n.bind(n,2362)),"@site/docs/interfaces/headstartwp_core.react.ISeparatorBlock.md",2362],"935f2afb":[()=>n.e(53).then(n.t.bind(n,1109,19)),"~docs/default/version-current-metadata-prop-751.json",1109],93679912:[()=>n.e(7870).then(n.bind(n,1842)),"@site/docs/classes/headstartwp_core.SearchFetchStrategy.md",1842],"93facf87":[()=>n.e(9981).then(n.t.bind(n,7371,19)),"/home/runner/work/headstartwp/headstartwp/docs/.docusaurus/docusaurus-plugin-content-docs/docs/plugin-route-context-module-100.json",7371],"950ec5f2":[()=>n.e(4909).then(n.bind(n,4957)),"@site/docs/classes/headstartwp_core.PostsArchiveFetchStrategy.md",4957],"95bb79e6":[()=>n.e(7667).then(n.bind(n,3375)),"@site/src/pages/philosophy.md",3375],"960bca7a":[()=>n.e(6809).then(n.bind(n,1571)),"@site/docs/enums/headstartwp_core.LOGTYPE.md",1571],"966ac8d5":[()=>n.e(2900).then(n.bind(n,2418)),"@site/docs/interfaces/headstartwp_core.react.CoverBlockProps.md",2418],"9689b62a":[()=>n.e(7244).then(n.bind(n,692)),"@site/docs/interfaces/headstartwp_core.Rendered.md",692],"96b34eb5":[()=>n.e(9108).then(n.bind(n,8203)),"@site/docs/interfaces/headstartwp_core.react.MediaTextBlockProps.md",8203],"9818e328":[()=>n.e(8673).then(n.bind(n,5142)),"@site/docs/interfaces/headstartwp_core.PostTypeEntity.md",5142],"99fcc669":[()=>n.e(8115).then(n.bind(n,5320)),"@site/documentation/02 - Data Fetching/useAuthorArchive.md",5320],"9be33a19":[()=>n.e(3131).then(n.bind(n,2414)),"@site/docs/interfaces/headstartwp_core.react.SeparatorBlockProps.md",2414],"9c66ae8c":[()=>n.e(1736).then(n.bind(n,8128)),"@site/docs/interfaces/headstartwp_core.react.WpThemeJSON.md",8128],a0d0f685:[()=>n.e(2424).then(n.bind(n,3224)),"@site/docs/classes/headstartwp_core.VerifyTokenFetchStrategy.md",3224],a1514d7c:[()=>n.e(2726).then(n.bind(n,2335)),"@site/docs/interfaces/headstartwp_core.react.IMediaTextBlock.md",2335],a222760f:[()=>n.e(4637).then(n.bind(n,5079)),"@site/docs/classes/headstartwp_core.NotFoundError.md",5079],a304918f:[()=>n.e(1075).then(n.bind(n,3495)),"@site/docs/interfaces/headstartwp_core.CommentEntity.md",3495],a3f5e611:[()=>n.e(4222).then(n.bind(n,6754)),"@site/docs/interfaces/headstartwp_core.react.BlockAttributes.md",6754],a40ccb42:[()=>n.e(8081).then(n.bind(n,4431)),"@site/docs/interfaces/headstartwp_core.react.IImageBlock.md",4431],a4f5c2b9:[()=>n.e(607).then(n.bind(n,7836)),"@site/docs/interfaces/headstartwp_core.MenuItemEntity.md",7836],a56bba46:[()=>n.e(7148).then(n.bind(n,4107)),"@site/docs/interfaces/headstartwp_next.FetchHookDataOptions.md",4107],a56c2626:[()=>n.e(2973).then(n.bind(n,1466)),"@site/docs/interfaces/headstartwp_core.react.useFetchOptions.md",1466],a6407ca9:[()=>n.e(7520).then(n.bind(n,2727)),"@site/docs/interfaces/headstartwp_core.react.IDataWPBlock.md",2727],ac461116:[()=>n.e(3514).then(n.bind(n,5081)),"@site/docs/interfaces/headstartwp_core.react.GutenbergBlockProps.md",5081],ae778953:[()=>n.e(9726).then(n.bind(n,6656)),"@site/documentation/02 - Data Fetching/useSearch.md",6656],b29fd792:[()=>n.e(6048).then(n.bind(n,7873)),"@site/docs/interfaces/headstartwp_core.react.TableBlockProps.md",7873],b2b781c5:[()=>n.e(6563).then(n.bind(n,4512)),"@site/docs/interfaces/headstartwp_core.react.IBlock.md",4512],b2de5b9f:[()=>n.e(9256).then(n.bind(n,6786)),"@site/docs/interfaces/headstartwp_core.PageInfo.md",6786],bd37eed7:[()=>n.e(6593).then(n.bind(n,1685)),"@site/docs/interfaces/headstartwp_core.react.IHeadingBlock.md",1685],bdcbc508:[()=>n.e(8039).then(n.bind(n,9753)),"@site/docs/interfaces/headstartwp_core.react.usePostsResponse.md",9753],c0c5ccb8:[()=>n.e(7721).then(n.bind(n,4020)),"@site/documentation/08-Guides/linaria.md",4020],c10c719f:[()=>n.e(9956).then(n.bind(n,4341)),"@site/docs/namespaces/headstartwp_next.config.md",4341],c377a04b:[()=>n.e(6971).then(n.bind(n,6653)),"@site/docs/index.md",6653],c4bf4659:[()=>n.e(856).then(n.bind(n,9015)),"@site/docs/interfaces/headstartwp_core.react.SpacerBlockProps.md",9015],c4f5d8e4:[()=>Promise.all([n.e(532),n.e(4195)]).then(n.bind(n,9598)),"@site/src/pages/index.js",9598],c75a8848:[()=>n.e(3435).then(n.bind(n,7862)),"@site/docs/classes/headstartwp_core.AuthorArchiveFetchStrategy.md",7862],c969edca:[()=>n.e(313).then(n.bind(n,7910)),"@site/docs/interfaces/headstartwp_core.FetchResponse.md",7910],c9e017d7:[()=>n.e(4038).then(n.bind(n,7029)),"@site/docs/classes/headstartwp_core.FetchError.md",7029],cb8267fc:[()=>n.e(7625).then(n.bind(n,8632)),"@site/docs/namespaces/headstartwp_next.middlewares.md",8632],cf8aa22f:[()=>n.e(9236).then(n.bind(n,6824)),"@site/docs/interfaces/headstartwp_core.PostParams.md",6824],cfec6fcb:[()=>n.e(9953).then(n.bind(n,3685)),"@site/documentation/05-Gutenberg/rendering-blocks-in-react-native.md",3685],d0ce585b:[()=>n.e(6255).then(n.bind(n,6098)),"@site/docs/interfaces/headstartwp_core.TermSearchEntity.md",6098],d19e169a:[()=>n.e(4504).then(n.bind(n,7545)),"@site/documentation/06-WordPress Integration/basic-auth.md",7545],d847ebfc:[()=>n.e(521).then(n.bind(n,6448)),"@site/documentation/02 - Data Fetching/prefetching-data-server.md",6448],d87415d1:[()=>n.e(5148).then(n.bind(n,96)),"@site/documentation/06-WordPress Integration/multisite.md",96],d9995696:[()=>n.e(5234).then(n.bind(n,8366)),"@site/docs/interfaces/headstartwp_core.Integration.md",8366],d9f3c1c7:[()=>n.e(62).then(n.bind(n,4845)),"@site/docs/interfaces/headstartwp_core.FilterDataOptions.md",4845],dcac5d89:[()=>n.e(7137).then(n.bind(n,627)),"@site/docs/interfaces/headstartwp_core.Entity.md",627],def27140:[()=>n.e(5593).then(n.bind(n,2529)),"@site/docs/interfaces/headstartwp_core.react.IPullQuoteBlock.md",2529],e088eb77:[()=>n.e(8089).then(n.bind(n,837)),"@site/docs/interfaces/headstartwp_core.react.IVerseBlock.md",837],e4594716:[()=>n.e(6623).then(n.bind(n,2481)),"@site/docs/classes/headstartwp_core.PostOrPostsFetchStrategy.md",2481],e518cb64:[()=>n.e(984).then(n.bind(n,1136)),"@site/docs/interfaces/headstartwp_core.react.IButtonBlock.md",1136],e9237c6a:[()=>n.e(535).then(n.bind(n,5875)),"@site/docs/classes/headstartwp_core.Text.md",5875],eb775807:[()=>n.e(8743).then(n.bind(n,8725)),"@site/docs/interfaces/headstartwp_core.react.useAppSettingsResponse.md",8725],ecbd967a:[()=>n.e(6307).then(n.bind(n,4148)),"@site/documentation/index.md",4148],ef311a1f:[()=>n.e(5278).then(n.bind(n,3408)),"@site/docs/interfaces/headstartwp_core.react.usePostOrPostResponse.md",3408],f1627269:[()=>n.e(5653).then(n.bind(n,7408)),"@site/documentation/06-WordPress Integration/polylang.md",7408],f2d13ce1:[()=>n.e(5355).then(n.bind(n,6393)),"@site/docs/interfaces/headstartwp_core.react.ColumnsBlockProps.md",6393],f3283cd4:[()=>n.e(8604).then(n.bind(n,260)),"@site/documentation/01-Getting Started/setting-up-manually.md",260],f3d95041:[()=>n.e(5405).then(n.bind(n,5364)),"@site/documentation/06-WordPress Integration/gutenberg.md",5364],f46c6fb7:[()=>n.e(1656).then(n.bind(n,3066)),"@site/docs/interfaces/headstartwp_core.react.IButtonsBlock.md",3066],f78eec9e:[()=>n.e(8239).then(n.bind(n,5664)),"@site/docs/interfaces/headstartwp_core.TypeEntity.md",5664],f9e6d01e:[()=>n.e(9898).then(n.bind(n,9373)),"@site/docs/interfaces/headstartwp_core.react.useMenuResponse.md",9373],fa160712:[()=>n.e(3589).then(n.bind(n,7848)),"@site/documentation/02 - Data Fetching/useSearchNative.md",7848],fae21d27:[()=>n.e(2179).then(n.bind(n,3283)),"@site/documentation/06-WordPress Integration/feeds.md",3283],fb675763:[()=>n.e(7067).then(n.bind(n,9905)),"@site/documentation/05-Gutenberg/rendering-blocks.md",9905],fd4b5c92:[()=>n.e(5123).then(n.bind(n,1670)),"@site/docs/interfaces/headstartwp_core.react.GroupBlockProps.md",1670]};function l(e){let{error:t,retry:n,pastDelay:a}=e;return t?r.createElement("div",{style:{textAlign:"center",color:"#fff",backgroundColor:"#fa383e",borderColor:"#fa383e",borderStyle:"solid",borderRadius:"0.25rem",borderWidth:"1px",boxSizing:"border-box",display:"block",padding:"1rem",flex:"0 0 50%",marginLeft:"25%",marginRight:"25%",marginTop:"5rem",maxWidth:"50%",width:"100%"}},r.createElement("p",null,String(t)),r.createElement("div",null,r.createElement("button",{type:"button",onClick:n},"Retry"))):a?r.createElement("div",{style:{display:"flex",justifyContent:"center",alignItems:"center",height:"100vh"}},r.createElement("svg",{id:"loader",style:{width:128,height:110,position:"absolute",top:"calc(100vh - 64%)"},viewBox:"0 0 45 45",xmlns:"http://www.w3.org/2000/svg",stroke:"#61dafb"},r.createElement("g",{fill:"none",fillRule:"evenodd",transform:"translate(1 1)",strokeWidth:"2"},r.createElement("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0"},r.createElement("animate",{attributeName:"r",begin:"1.5s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),r.createElement("animate",{attributeName:"stroke-opacity",begin:"1.5s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),r.createElement("animate",{attributeName:"stroke-width",begin:"1.5s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})),r.createElement("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0"},r.createElement("animate",{attributeName:"r",begin:"3s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),r.createElement("animate",{attributeName:"stroke-opacity",begin:"3s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),r.createElement("animate",{attributeName:"stroke-width",begin:"3s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})),r.createElement("circle",{cx:"22",cy:"22",r:"8"},r.createElement("animate",{attributeName:"r",begin:"0s",dur:"1.5s",values:"6;1;2;3;4;5;6",calcMode:"linear",repeatCount:"indefinite"}))))):null}var u=n(9670),d=n(226);function p(e,t){if("*"===e)return i()({loading:l,loader:()=>n.e(4972).then(n.bind(n,4972)),modules:["@theme/NotFound"],webpack:()=>[4972],render(e,t){const n=e.default;return r.createElement(d.z,{value:{plugin:{name:"native",id:"default"}}},r.createElement(n,t))}});const o=s[`${e}-${t}`],p={},f=[],h=[],m=(0,u.Z)(o);return Object.entries(m).forEach((e=>{let[t,n]=e;const r=c[n];r&&(p[t]=r[0],f.push(r[1]),h.push(r[2]))})),i().Map({loading:l,loader:p,modules:f,webpack:()=>h,render(t,n){const i=JSON.parse(JSON.stringify(o));Object.entries(t).forEach((t=>{let[n,r]=t;const a=r.default;if(!a)throw new Error(`The page component at ${e} doesn't have a default export. This makes it impossible to render anything. Consider default-exporting a React component.`);"object"!=typeof a&&"function"!=typeof a||Object.keys(r).filter((e=>"default"!==e)).forEach((e=>{a[e]=r[e]}));let o=i;const s=n.split(".");s.slice(0,-1).forEach((e=>{o=o[e]})),o[s[s.length-1]]=a}));const s=i.__comp;delete i.__comp;const c=i.__context;return delete i.__context,r.createElement(d.z,{value:c},r.createElement(s,(0,a.Z)({},i,n)))}})}const f=[{path:"/docs/philosophy/",component:p("/docs/philosophy/","0f4"),exact:!0},{path:"/docs/search/",component:p("/docs/search/","8da"),exact:!0},{path:"/docs/api/",component:p("/docs/api/","953"),routes:[{path:"/docs/api/",component:p("/docs/api/","5bb"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/classes/headstartwp_core.AbstractFetchStrategy/",component:p("/docs/api/classes/headstartwp_core.AbstractFetchStrategy/","456"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/classes/headstartwp_core.AppSettingsStrategy/",component:p("/docs/api/classes/headstartwp_core.AppSettingsStrategy/","0d6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/",component:p("/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy/","831"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/classes/headstartwp_core.Comment/",component:p("/docs/api/classes/headstartwp_core.Comment/","ce6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/classes/headstartwp_core.ConfigError/",component:p("/docs/api/classes/headstartwp_core.ConfigError/","ee5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/classes/headstartwp_core.Element/",component:p("/docs/api/classes/headstartwp_core.Element/","df3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/classes/headstartwp_core.EndpointError/",component:p("/docs/api/classes/headstartwp_core.EndpointError/","9f5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/classes/headstartwp_core.FetchError/",component:p("/docs/api/classes/headstartwp_core.FetchError/","215"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/classes/headstartwp_core.FrameworkError/",component:p("/docs/api/classes/headstartwp_core.FrameworkError/","289"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/classes/headstartwp_core.NotFoundError/",component:p("/docs/api/classes/headstartwp_core.NotFoundError/","0d6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/",component:p("/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy/","c91"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/",component:p("/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy/","ae7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/classes/headstartwp_core.ProcessingInstruction/",component:p("/docs/api/classes/headstartwp_core.ProcessingInstruction/","d7a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/classes/headstartwp_core.SearchFetchStrategy/",component:p("/docs/api/classes/headstartwp_core.SearchFetchStrategy/","0eb"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/classes/headstartwp_core.SearchNativeFetchStrategy/",component:p("/docs/api/classes/headstartwp_core.SearchNativeFetchStrategy/","b8f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/",component:p("/docs/api/classes/headstartwp_core.SinglePostFetchStrategy/","c0f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy/",component:p("/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy/","161"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/classes/headstartwp_core.Text/",component:p("/docs/api/classes/headstartwp_core.Text/","700"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy/",component:p("/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy/","475"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/enums/headstartwp_core.LOGTYPE/",component:p("/docs/api/enums/headstartwp_core.LOGTYPE/","0af"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.AppEntity/",component:p("/docs/api/interfaces/headstartwp_core.AppEntity/","7f3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.AttachmentEntity/",component:p("/docs/api/interfaces/headstartwp_core.AttachmentEntity/","854"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.AuthorEntity/",component:p("/docs/api/interfaces/headstartwp_core.AuthorEntity/","997"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.AvatarUrls/",component:p("/docs/api/interfaces/headstartwp_core.AvatarUrls/","b4b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.CommentEntity/",component:p("/docs/api/interfaces/headstartwp_core.CommentEntity/","929"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.EndpointParams/",component:p("/docs/api/interfaces/headstartwp_core.EndpointParams/","c6f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.Entity/",component:p("/docs/api/interfaces/headstartwp_core.Entity/","83b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.FetchOptions/",component:p("/docs/api/interfaces/headstartwp_core.FetchOptions/","b8a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.FetchResponse/",component:p("/docs/api/interfaces/headstartwp_core.FetchResponse/","6bd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.FilterDataOptions/",component:p("/docs/api/interfaces/headstartwp_core.FilterDataOptions/","57a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions/",component:p("/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions/","3ea"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.Integration/",component:p("/docs/api/interfaces/headstartwp_core.Integration/","6de"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.MenuItemEntity/",component:p("/docs/api/interfaces/headstartwp_core.MenuItemEntity/","47b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.PageEntity/",component:p("/docs/api/interfaces/headstartwp_core.PageEntity/","9c7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.PageInfo/",component:p("/docs/api/interfaces/headstartwp_core.PageInfo/","0f7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.PolylangIntegration/",component:p("/docs/api/interfaces/headstartwp_core.PolylangIntegration/","d24"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.PostEntity/",component:p("/docs/api/interfaces/headstartwp_core.PostEntity/","c3b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.PostOrPostsParams/",component:p("/docs/api/interfaces/headstartwp_core.PostOrPostsParams/","066"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.PostParams/",component:p("/docs/api/interfaces/headstartwp_core.PostParams/","fab"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.PostsArchiveParams/",component:p("/docs/api/interfaces/headstartwp_core.PostsArchiveParams/","97e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.PostSearchEntity/",component:p("/docs/api/interfaces/headstartwp_core.PostSearchEntity/","a32"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.PostTypeEntity/",component:p("/docs/api/interfaces/headstartwp_core.PostTypeEntity/","680"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps/",component:p("/docs/api/interfaces/headstartwp_core.react.AudioBlockProps/","960"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.BlockAttributes/",component:p("/docs/api/interfaces/headstartwp_core.react.BlockAttributes/","c90"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.BlockProps/",component:p("/docs/api/interfaces/headstartwp_core.react.BlockProps/","44f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.BlockRendererProps/",component:p("/docs/api/interfaces/headstartwp_core.react.BlockRendererProps/","d13"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps/",component:p("/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps/","e47"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps/",component:p("/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps/","8e1"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps/",component:p("/docs/api/interfaces/headstartwp_core.react.CodeBlockProps/","602"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.Colors/",component:p("/docs/api/interfaces/headstartwp_core.react.Colors/","f36"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps/",component:p("/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps/","6ab"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps/",component:p("/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps/","bef"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps/",component:p("/docs/api/interfaces/headstartwp_core.react.CoverBlockProps/","77f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions/",component:p("/docs/api/interfaces/headstartwp_core.react.FetchHookOptions/","398"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.FileBlockProps/",component:p("/docs/api/interfaces/headstartwp_core.react.FileBlockProps/","0bc"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps/",component:p("/docs/api/interfaces/headstartwp_core.react.GroupBlockProps/","c0b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.GutenbergBlockProps/",component:p("/docs/api/interfaces/headstartwp_core.react.GutenbergBlockProps/","d77"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps/",component:p("/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps/","689"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.HookResponse/",component:p("/docs/api/interfaces/headstartwp_core.react.HookResponse/","cfa"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.HtmlDecodeProps/",component:p("/docs/api/interfaces/headstartwp_core.react.HtmlDecodeProps/","ddc"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.IAudioBlock/",component:p("/docs/api/interfaces/headstartwp_core.react.IAudioBlock/","860"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.IBlock/",component:p("/docs/api/interfaces/headstartwp_core.react.IBlock/","fb5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes/",component:p("/docs/api/interfaces/headstartwp_core.react.IBlockAttributes/","681"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.IButtonBlock/",component:p("/docs/api/interfaces/headstartwp_core.react.IButtonBlock/","829"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.IButtonsBlock/",component:p("/docs/api/interfaces/headstartwp_core.react.IButtonsBlock/","10a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.ICodeBlock/",component:p("/docs/api/interfaces/headstartwp_core.react.ICodeBlock/","aa9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.IColumnBlock/",component:p("/docs/api/interfaces/headstartwp_core.react.IColumnBlock/","8dd"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.IColumnsBlock/",component:p("/docs/api/interfaces/headstartwp_core.react.IColumnsBlock/","a6b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.ICoverBlock/",component:p("/docs/api/interfaces/headstartwp_core.react.ICoverBlock/","1cb"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.IDataWPBlock/",component:p("/docs/api/interfaces/headstartwp_core.react.IDataWPBlock/","127"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.IFileBlock/",component:p("/docs/api/interfaces/headstartwp_core.react.IFileBlock/","95c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.IGroupBlock/",component:p("/docs/api/interfaces/headstartwp_core.react.IGroupBlock/","fff"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.IHeadingBlock/",component:p("/docs/api/interfaces/headstartwp_core.react.IHeadingBlock/","06c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.IImageBlock/",component:p("/docs/api/interfaces/headstartwp_core.react.IImageBlock/","39c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.IListBlock/",component:p("/docs/api/interfaces/headstartwp_core.react.IListBlock/","3fe"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps/",component:p("/docs/api/interfaces/headstartwp_core.react.ImageBlockProps/","f21"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.IMediaTextBlock/",component:p("/docs/api/interfaces/headstartwp_core.react.IMediaTextBlock/","74f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.IParagraphBlock/",component:p("/docs/api/interfaces/headstartwp_core.react.IParagraphBlock/","1a0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.IPreformattedBlock/",component:p("/docs/api/interfaces/headstartwp_core.react.IPreformattedBlock/","6bf"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.IPullQuoteBlock/",component:p("/docs/api/interfaces/headstartwp_core.react.IPullQuoteBlock/","032"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.IQuoteBlock/",component:p("/docs/api/interfaces/headstartwp_core.react.IQuoteBlock/","730"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.ISeparatorBlock/",component:p("/docs/api/interfaces/headstartwp_core.react.ISeparatorBlock/","548"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.ISpacerBlock/",component:p("/docs/api/interfaces/headstartwp_core.react.ISpacerBlock/","cb6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.ITableBlock/",component:p("/docs/api/interfaces/headstartwp_core.react.ITableBlock/","bf6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.IVerseBlock/",component:p("/docs/api/interfaces/headstartwp_core.react.IVerseBlock/","52c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock/",component:p("/docs/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock/","5a0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.ListBlockProps/",component:p("/docs/api/interfaces/headstartwp_core.react.ListBlockProps/","26e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps/",component:p("/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps/","96b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps/",component:p("/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps/","6c0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps/",component:p("/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps/","ee6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps/",component:p("/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps/","ce8"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps/",component:p("/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps/","f30"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.SafeHtmlProps/",component:p("/docs/api/interfaces/headstartwp_core.react.SafeHtmlProps/","56b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps/",component:p("/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps/","df8"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties/",component:p("/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties/","d87"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.SettingsProperties/",component:p("/docs/api/interfaces/headstartwp_core.react.SettingsProperties/","9c9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps/",component:p("/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps/","0a2"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete/",component:p("/docs/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete/","4a9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.StylesProperties/",component:p("/docs/api/interfaces/headstartwp_core.react.StylesProperties/","bb3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.TableBlockProps/",component:p("/docs/api/interfaces/headstartwp_core.react.TableBlockProps/","ee7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.Typography/",component:p("/docs/api/interfaces/headstartwp_core.react.Typography/","9c5"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse/",component:p("/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse/","abb"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.useFetchOptions/",component:p("/docs/api/interfaces/headstartwp_core.react.useFetchOptions/","109"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.useMenuResponse/",component:p("/docs/api/interfaces/headstartwp_core.react.useMenuResponse/","c36"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse/",component:p("/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse/","924"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.usePostResponse/",component:p("/docs/api/interfaces/headstartwp_core.react.usePostResponse/","8fa"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.usePostsResponse/",component:p("/docs/api/interfaces/headstartwp_core.react.usePostsResponse/","70f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.useSearchNativeResponse/",component:p("/docs/api/interfaces/headstartwp_core.react.useSearchNativeResponse/","871"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.useSearchResponse/",component:p("/docs/api/interfaces/headstartwp_core.react.useSearchResponse/","77f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.useTermsResponse/",component:p("/docs/api/interfaces/headstartwp_core.react.useTermsResponse/","576"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps/",component:p("/docs/api/interfaces/headstartwp_core.react.VerseBlockProps/","dd4"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.WpThemeJSON/",component:p("/docs/api/interfaces/headstartwp_core.react.WpThemeJSON/","4cc"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps/",component:p("/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps/","98e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.Rendered/",component:p("/docs/api/interfaces/headstartwp_core.Rendered/","482"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.RevisionEntity/",component:p("/docs/api/interfaces/headstartwp_core.RevisionEntity/","60d"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.SearchEntity/",component:p("/docs/api/interfaces/headstartwp_core.SearchEntity/","f25"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.SearchObjectEntity/",component:p("/docs/api/interfaces/headstartwp_core.SearchObjectEntity/","46c"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.SearchParams/",component:p("/docs/api/interfaces/headstartwp_core.SearchParams/","d87"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams/",component:p("/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams/","25f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.TaxonomyEntity/",component:p("/docs/api/interfaces/headstartwp_core.TaxonomyEntity/","5a8"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.TermEntity/",component:p("/docs/api/interfaces/headstartwp_core.TermEntity/","484"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.TermSearchEntity/",component:p("/docs/api/interfaces/headstartwp_core.TermSearchEntity/","66a"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.TypeEntity/",component:p("/docs/api/interfaces/headstartwp_core.TypeEntity/","992"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.VerifyTokenParams/",component:p("/docs/api/interfaces/headstartwp_core.VerifyTokenParams/","513"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_core.YoastSEOIntegration/",component:p("/docs/api/interfaces/headstartwp_core.YoastSEOIntegration/","f8b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_next.FetchHookDataOptions/",component:p("/docs/api/interfaces/headstartwp_next.FetchHookDataOptions/","157"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_next.ImageProps/",component:p("/docs/api/interfaces/headstartwp_next.ImageProps/","9b4"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/interfaces/headstartwp_next.LinkBlockProps/",component:p("/docs/api/interfaces/headstartwp_next.LinkBlockProps/","d77"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/modules/headstartwp_core/",component:p("/docs/api/modules/headstartwp_core/","775"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/modules/headstartwp_next/",component:p("/docs/api/modules/headstartwp_next/","9f9"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/namespaces/headstartwp_core.react/",component:p("/docs/api/namespaces/headstartwp_core.react/","c46"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/namespaces/headstartwp_next.config/",component:p("/docs/api/namespaces/headstartwp_next.config/","dac"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/api/namespaces/headstartwp_next.middlewares/",component:p("/docs/api/namespaces/headstartwp_next.middlewares/","18d"),exact:!0,sidebar:"tutorialSidebar"}]},{path:"/docs/learn/",component:p("/docs/learn/","2c8"),routes:[{path:"/docs/learn/",component:p("/docs/learn/","a18"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/data-fetching/",component:p("/docs/learn/data-fetching/","77e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/data-fetching/creating-your-own-custom-hooks/",component:p("/docs/learn/data-fetching/creating-your-own-custom-hooks/","427"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/data-fetching/prefetching/",component:p("/docs/learn/data-fetching/prefetching/","05e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/data-fetching/use-post-or-posts/",component:p("/docs/learn/data-fetching/use-post-or-posts/","473"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/data-fetching/useauthorarchive/",component:p("/docs/learn/data-fetching/useauthorarchive/","302"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/data-fetching/usepost/",component:p("/docs/learn/data-fetching/usepost/","a3f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/data-fetching/useposts/",component:p("/docs/learn/data-fetching/useposts/","a8f"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/data-fetching/usesearch-native/",component:p("/docs/learn/data-fetching/usesearch-native/","531"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/data-fetching/usesearch/",component:p("/docs/learn/data-fetching/usesearch/","3c6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/data-fetching/useSeo/",component:p("/docs/learn/data-fetching/useSeo/","51b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/data-fetching/useterms/",component:p("/docs/learn/data-fetching/useterms/","b67"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/getting-started/headless-config/",component:p("/docs/learn/getting-started/headless-config/","bd4"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/getting-started/installing-wordpress-plugin/",component:p("/docs/learn/getting-started/installing-wordpress-plugin/","c7e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/getting-started/quick-setup/",component:p("/docs/learn/getting-started/quick-setup/","9d6"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/getting-started/quick-tutorial/",component:p("/docs/learn/getting-started/quick-tutorial/","9d7"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/getting-started/setting-up-manually/",component:p("/docs/learn/getting-started/setting-up-manually/","113"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/Guides/ab-test-link/",component:p("/docs/learn/Guides/ab-test-link/","ce0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/Guides/linaria/",component:p("/docs/learn/Guides/linaria/","3c0"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/Guides/typescript/",component:p("/docs/learn/Guides/typescript/","039"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/Guides/youtube-facade/",component:p("/docs/learn/Guides/youtube-facade/","ca4"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/gutenberg/rendering-blocks-in-react-native/",component:p("/docs/learn/gutenberg/rendering-blocks-in-react-native/","f99"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/gutenberg/rendering-blocks/",component:p("/docs/learn/gutenberg/rendering-blocks/","863"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/gutenberg/rendering-custom-blocks/",component:p("/docs/learn/gutenberg/rendering-custom-blocks/","928"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/utilities/sanitization/",component:p("/docs/learn/utilities/sanitization/","09e"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/wordpress-integration/basic-auth/",component:p("/docs/learn/wordpress-integration/basic-auth/","791"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/wordpress-integration/feeds/",component:p("/docs/learn/wordpress-integration/feeds/","9b4"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/wordpress-integration/gutenberg/",component:p("/docs/learn/wordpress-integration/gutenberg/","f55"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/wordpress-integration/multisite/",component:p("/docs/learn/wordpress-integration/multisite/","1d3"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/wordpress-integration/polylang/",component:p("/docs/learn/wordpress-integration/polylang/","38b"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/wordpress-integration/previews/",component:p("/docs/learn/wordpress-integration/previews/","733"),exact:!0,sidebar:"tutorialSidebar"},{path:"/docs/learn/wordpress-integration/revalidate/",component:p("/docs/learn/wordpress-integration/revalidate/","f0d"),exact:!0,sidebar:"tutorialSidebar"}]},{path:"/docs/",component:p("/docs/","890"),exact:!0},{path:"*",component:p("*")}]},8934:(e,t,n)=>{"use strict";n.d(t,{_:()=>a,t:()=>o});var r=n(7294);const a=r.createContext(!1);function o(e){let{children:t}=e;const[n,o]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{o(!0)}),[]),r.createElement(a.Provider,{value:n},t)}},9383:(e,t,n)=>{"use strict";var r=n(7294),a=n(3935),o=n(3727),i=n(405),s=n(412);const c=[n(6657),n(2497),n(3310),n(8320),n(2295)];var l=n(723),u=n(6550),d=n(8790);function p(e){let{children:t}=e;return r.createElement(r.Fragment,null,t)}var f=n(7462),h=n(5742),m=n(2263),g=n(4996),b=n(6668),y=n(1944),v=n(4711),w=n(9727),_=n(3320),k=n(197);function S(){const{i18n:{defaultLocale:e,localeConfigs:t}}=(0,m.Z)(),n=(0,v.l)();return r.createElement(h.Z,null,Object.entries(t).map((e=>{let[t,{htmlLang:a}]=e;return r.createElement("link",{key:t,rel:"alternate",href:n.createUrl({locale:t,fullyQualified:!0}),hrefLang:a})})),r.createElement("link",{rel:"alternate",href:n.createUrl({locale:e,fullyQualified:!0}),hrefLang:"x-default"}))}function E(e){let{permalink:t}=e;const{siteConfig:{url:n}}=(0,m.Z)(),a=function(){const{siteConfig:{url:e}}=(0,m.Z)(),{pathname:t}=(0,u.TH)();return e+(0,g.Z)(t)}(),o=t?`${n}${t}`:a;return r.createElement(h.Z,null,r.createElement("meta",{property:"og:url",content:o}),r.createElement("link",{rel:"canonical",href:o}))}function x(){const{i18n:{currentLocale:e}}=(0,m.Z)(),{metadata:t,image:n}=(0,b.L)();return r.createElement(r.Fragment,null,r.createElement(h.Z,null,r.createElement("meta",{name:"twitter:card",content:"summary_large_image"}),r.createElement("body",{className:w.h})),n&&r.createElement(y.d,{image:n}),r.createElement(E,null),r.createElement(S,null),r.createElement(k.Z,{tag:_.HX,locale:e}),r.createElement(h.Z,null,t.map(((e,t)=>r.createElement("meta",(0,f.Z)({key:t},e))))))}const P=new Map;function T(e){if(P.has(e.pathname))return{...e,pathname:P.get(e.pathname)};if((0,d.f)(l.Z,e.pathname).some((e=>{let{route:t}=e;return!0===t.exact})))return P.set(e.pathname,e.pathname),e;const t=e.pathname.trim().replace(/(?:\/index)?\.html$/,"")||"/";return P.set(e.pathname,t),{...e,pathname:t}}var C=n(8934),I=n(8940);function A(e){for(var t=arguments.length,n=new Array(t>1?t-1:0),r=1;r(t.default?.[e]??t[e])?.(...n)));return()=>a.forEach((e=>e?.()))}const O=function(e){let{children:t,location:n,previousLocation:a}=e;return(0,r.useLayoutEffect)((()=>{a!==n&&(!function(e){let{location:t,previousLocation:n}=e;if(!n)return;const r=t.pathname===n.pathname,a=t.hash===n.hash,o=t.search===n.search;if(r&&a&&!o)return;const{hash:i}=t;if(i){const e=decodeURIComponent(i.substring(1));document.getElementById(e)?.scrollIntoView()}else window.scrollTo(0,0)}({location:n,previousLocation:a}),A("onRouteDidUpdate",{previousLocation:a,location:n}))}),[a,n]),t};function L(e){const t=Array.from(new Set([e,decodeURI(e)])).map((e=>(0,d.f)(l.Z,e))).flat();return Promise.all(t.map((e=>e.route.component.preload?.())))}class N extends r.Component{constructor(e){super(e),this.previousLocation=void 0,this.routeUpdateCleanupCb=void 0,this.previousLocation=null,this.routeUpdateCleanupCb=s.Z.canUseDOM?A("onRouteUpdate",{previousLocation:null,location:this.props.location}):()=>{},this.state={nextRouteHasLoaded:!0}}shouldComponentUpdate(e,t){if(e.location===this.props.location)return t.nextRouteHasLoaded;const n=e.location;return this.previousLocation=this.props.location,this.setState({nextRouteHasLoaded:!1}),this.routeUpdateCleanupCb=A("onRouteUpdate",{previousLocation:this.previousLocation,location:n}),L(n.pathname).then((()=>{this.routeUpdateCleanupCb(),this.setState({nextRouteHasLoaded:!0})})).catch((e=>{console.warn(e),window.location.reload()})),!1}render(){const{children:e,location:t}=this.props;return r.createElement(O,{previousLocation:this.previousLocation,location:t},r.createElement(u.AW,{location:t,render:()=>e}))}}const R=N,B="docusaurus-base-url-issue-banner-container",F="docusaurus-base-url-issue-banner-suggestion-container",D="__DOCUSAURUS_INSERT_BASEURL_BANNER";function M(e){return`\nwindow['${D}'] = true;\n\ndocument.addEventListener('DOMContentLoaded', maybeInsertBanner);\n\nfunction maybeInsertBanner() {\n var shouldInsert = window['${D}'];\n shouldInsert && insertBanner();\n}\n\nfunction insertBanner() {\n var bannerContainer = document.getElementById('${B}');\n if (!bannerContainer) {\n return;\n }\n var bannerHtml = ${JSON.stringify(function(e){return`\n
\n

Your Docusaurus site did not load properly.

\n

A very common reason is a wrong site baseUrl configuration.

\n

Current configured baseUrl = ${e} ${"/"===e?" (default value)":""}

\n

We suggest trying baseUrl =

\n
\n`}(e)).replace(/{window[D]=!1}),[]),r.createElement(r.Fragment,null,!s.Z.canUseDOM&&r.createElement(h.Z,null,r.createElement("script",null,M(e))),r.createElement("div",{id:B}))}function z(){const{siteConfig:{baseUrl:e,baseUrlIssueBanner:t}}=(0,m.Z)(),{pathname:n}=(0,u.TH)();return t&&n===e?r.createElement($,null):null}function U(){const{siteConfig:{favicon:e,title:t,noIndex:n},i18n:{currentLocale:a,localeConfigs:o}}=(0,m.Z)(),i=(0,g.Z)(e),{htmlLang:s,direction:c}=o[a];return r.createElement(h.Z,null,r.createElement("html",{lang:s,dir:c}),r.createElement("title",null,t),r.createElement("meta",{property:"og:title",content:t}),r.createElement("meta",{name:"viewport",content:"width=device-width, initial-scale=1.0"}),n&&r.createElement("meta",{name:"robots",content:"noindex, nofollow"}),e&&r.createElement("link",{rel:"icon",href:i}))}var j=n(4763);function H(){const e=(0,d.H)(l.Z),t=(0,u.TH)();return r.createElement(j.Z,null,r.createElement(I.M,null,r.createElement(C.t,null,r.createElement(p,null,r.createElement(U,null),r.createElement(x,null),r.createElement(z,null),r.createElement(R,{location:T(t)},e)))))}var G=n(6887);const Z=function(e){try{return document.createElement("link").relList.supports(e)}catch{return!1}}("prefetch")?function(e){return new Promise(((t,n)=>{if("undefined"==typeof document)return void n();const r=document.createElement("link");r.setAttribute("rel","prefetch"),r.setAttribute("href",e),r.onload=()=>t(),r.onerror=()=>n();(document.getElementsByTagName("head")[0]??document.getElementsByName("script")[0]?.parentNode)?.appendChild(r)}))}:function(e){return new Promise(((t,n)=>{const r=new XMLHttpRequest;r.open("GET",e,!0),r.withCredentials=!0,r.onload=()=>{200===r.status?t():n()},r.send(null)}))};var Q=n(9670);const V=new Set,W=new Set,q=()=>navigator.connection?.effectiveType.includes("2g")||navigator.connection?.saveData,Y={prefetch(e){if(!(e=>!q()&&!W.has(e)&&!V.has(e))(e))return!1;V.add(e);const t=(0,d.f)(l.Z,e).flatMap((e=>{return t=e.route.path,Object.entries(G).filter((e=>{let[n]=e;return n.replace(/-[^-]+$/,"")===t})).flatMap((e=>{let[,t]=e;return Object.values((0,Q.Z)(t))}));var t}));return Promise.all(t.map((e=>{const t=n.gca(e);return t&&!t.includes("undefined")?Z(t).catch((()=>{})):Promise.resolve()})))},preload:e=>!!(e=>!q()&&!W.has(e))(e)&&(W.add(e),L(e))},K=Object.freeze(Y);if(s.Z.canUseDOM){window.docusaurus=K;const e=a.hydrate;L(window.location.pathname).then((()=>{e(r.createElement(i.B6,null,r.createElement(o.VK,null,r.createElement(H,null))),document.getElementById("__docusaurus"))}))}},8940:(e,t,n)=>{"use strict";n.d(t,{_:()=>u,M:()=>d});var r=n(7294),a=n(6809);const o=JSON.parse('{"docusaurus-plugin-google-gtag":{"default":{"trackingID":"G-WF1Z7JSCXS","anonymizeIP":true,"id":"default"}},"docusaurus-plugin-content-docs":{"docs":{"path":"/docs/api","versions":[{"name":"current","label":"Next","isLast":true,"path":"/docs/api","mainDocId":"index","docs":[{"id":"classes/headstartwp_core.AbstractFetchStrategy","path":"/docs/api/classes/headstartwp_core.AbstractFetchStrategy","sidebar":"tutorialSidebar"},{"id":"classes/headstartwp_core.AppSettingsStrategy","path":"/docs/api/classes/headstartwp_core.AppSettingsStrategy","sidebar":"tutorialSidebar"},{"id":"classes/headstartwp_core.AuthorArchiveFetchStrategy","path":"/docs/api/classes/headstartwp_core.AuthorArchiveFetchStrategy","sidebar":"tutorialSidebar"},{"id":"classes/headstartwp_core.Comment","path":"/docs/api/classes/headstartwp_core.Comment","sidebar":"tutorialSidebar"},{"id":"classes/headstartwp_core.ConfigError","path":"/docs/api/classes/headstartwp_core.ConfigError","sidebar":"tutorialSidebar"},{"id":"classes/headstartwp_core.Element","path":"/docs/api/classes/headstartwp_core.Element","sidebar":"tutorialSidebar"},{"id":"classes/headstartwp_core.EndpointError","path":"/docs/api/classes/headstartwp_core.EndpointError","sidebar":"tutorialSidebar"},{"id":"classes/headstartwp_core.FetchError","path":"/docs/api/classes/headstartwp_core.FetchError","sidebar":"tutorialSidebar"},{"id":"classes/headstartwp_core.FrameworkError","path":"/docs/api/classes/headstartwp_core.FrameworkError","sidebar":"tutorialSidebar"},{"id":"classes/headstartwp_core.NotFoundError","path":"/docs/api/classes/headstartwp_core.NotFoundError","sidebar":"tutorialSidebar"},{"id":"classes/headstartwp_core.PostOrPostsFetchStrategy","path":"/docs/api/classes/headstartwp_core.PostOrPostsFetchStrategy","sidebar":"tutorialSidebar"},{"id":"classes/headstartwp_core.PostsArchiveFetchStrategy","path":"/docs/api/classes/headstartwp_core.PostsArchiveFetchStrategy","sidebar":"tutorialSidebar"},{"id":"classes/headstartwp_core.ProcessingInstruction","path":"/docs/api/classes/headstartwp_core.ProcessingInstruction","sidebar":"tutorialSidebar"},{"id":"classes/headstartwp_core.SearchFetchStrategy","path":"/docs/api/classes/headstartwp_core.SearchFetchStrategy","sidebar":"tutorialSidebar"},{"id":"classes/headstartwp_core.SearchNativeFetchStrategy","path":"/docs/api/classes/headstartwp_core.SearchNativeFetchStrategy","sidebar":"tutorialSidebar"},{"id":"classes/headstartwp_core.SinglePostFetchStrategy","path":"/docs/api/classes/headstartwp_core.SinglePostFetchStrategy","sidebar":"tutorialSidebar"},{"id":"classes/headstartwp_core.TaxonomyTermsStrategy","path":"/docs/api/classes/headstartwp_core.TaxonomyTermsStrategy","sidebar":"tutorialSidebar"},{"id":"classes/headstartwp_core.Text","path":"/docs/api/classes/headstartwp_core.Text","sidebar":"tutorialSidebar"},{"id":"classes/headstartwp_core.VerifyTokenFetchStrategy","path":"/docs/api/classes/headstartwp_core.VerifyTokenFetchStrategy","sidebar":"tutorialSidebar"},{"id":"enums/headstartwp_core.LOGTYPE","path":"/docs/api/enums/headstartwp_core.LOGTYPE","sidebar":"tutorialSidebar"},{"id":"index","path":"/docs/api/","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.AppEntity","path":"/docs/api/interfaces/headstartwp_core.AppEntity","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.AttachmentEntity","path":"/docs/api/interfaces/headstartwp_core.AttachmentEntity","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.AuthorEntity","path":"/docs/api/interfaces/headstartwp_core.AuthorEntity","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.AvatarUrls","path":"/docs/api/interfaces/headstartwp_core.AvatarUrls","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.CommentEntity","path":"/docs/api/interfaces/headstartwp_core.CommentEntity","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.EndpointParams","path":"/docs/api/interfaces/headstartwp_core.EndpointParams","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.Entity","path":"/docs/api/interfaces/headstartwp_core.Entity","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.FetchOptions","path":"/docs/api/interfaces/headstartwp_core.FetchOptions","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.FetchResponse","path":"/docs/api/interfaces/headstartwp_core.FetchResponse","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.FilterDataOptions","path":"/docs/api/interfaces/headstartwp_core.FilterDataOptions","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.HTMLReactParserOptions","path":"/docs/api/interfaces/headstartwp_core.HTMLReactParserOptions","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.Integration","path":"/docs/api/interfaces/headstartwp_core.Integration","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.MenuItemEntity","path":"/docs/api/interfaces/headstartwp_core.MenuItemEntity","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.PageEntity","path":"/docs/api/interfaces/headstartwp_core.PageEntity","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.PageInfo","path":"/docs/api/interfaces/headstartwp_core.PageInfo","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.PolylangIntegration","path":"/docs/api/interfaces/headstartwp_core.PolylangIntegration","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.PostEntity","path":"/docs/api/interfaces/headstartwp_core.PostEntity","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.PostOrPostsParams","path":"/docs/api/interfaces/headstartwp_core.PostOrPostsParams","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.PostParams","path":"/docs/api/interfaces/headstartwp_core.PostParams","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.PostsArchiveParams","path":"/docs/api/interfaces/headstartwp_core.PostsArchiveParams","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.PostSearchEntity","path":"/docs/api/interfaces/headstartwp_core.PostSearchEntity","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.PostTypeEntity","path":"/docs/api/interfaces/headstartwp_core.PostTypeEntity","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.AudioBlockProps","path":"/docs/api/interfaces/headstartwp_core.react.AudioBlockProps","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.BlockAttributes","path":"/docs/api/interfaces/headstartwp_core.react.BlockAttributes","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.BlockProps","path":"/docs/api/interfaces/headstartwp_core.react.BlockProps","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.BlockRendererProps","path":"/docs/api/interfaces/headstartwp_core.react.BlockRendererProps","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.ButtonBlockProps","path":"/docs/api/interfaces/headstartwp_core.react.ButtonBlockProps","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.ButtonsBlockProps","path":"/docs/api/interfaces/headstartwp_core.react.ButtonsBlockProps","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.CodeBlockProps","path":"/docs/api/interfaces/headstartwp_core.react.CodeBlockProps","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.Colors","path":"/docs/api/interfaces/headstartwp_core.react.Colors","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.ColumnBlockProps","path":"/docs/api/interfaces/headstartwp_core.react.ColumnBlockProps","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.ColumnsBlockProps","path":"/docs/api/interfaces/headstartwp_core.react.ColumnsBlockProps","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.CoverBlockProps","path":"/docs/api/interfaces/headstartwp_core.react.CoverBlockProps","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.FetchHookOptions","path":"/docs/api/interfaces/headstartwp_core.react.FetchHookOptions","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.FileBlockProps","path":"/docs/api/interfaces/headstartwp_core.react.FileBlockProps","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.GroupBlockProps","path":"/docs/api/interfaces/headstartwp_core.react.GroupBlockProps","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.GutenbergBlockProps","path":"/docs/api/interfaces/headstartwp_core.react.GutenbergBlockProps","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.HeadingBlockProps","path":"/docs/api/interfaces/headstartwp_core.react.HeadingBlockProps","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.HookResponse","path":"/docs/api/interfaces/headstartwp_core.react.HookResponse","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.HtmlDecodeProps","path":"/docs/api/interfaces/headstartwp_core.react.HtmlDecodeProps","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.IAudioBlock","path":"/docs/api/interfaces/headstartwp_core.react.IAudioBlock","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.IBlock","path":"/docs/api/interfaces/headstartwp_core.react.IBlock","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.IBlockAttributes","path":"/docs/api/interfaces/headstartwp_core.react.IBlockAttributes","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.IButtonBlock","path":"/docs/api/interfaces/headstartwp_core.react.IButtonBlock","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.IButtonsBlock","path":"/docs/api/interfaces/headstartwp_core.react.IButtonsBlock","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.ICodeBlock","path":"/docs/api/interfaces/headstartwp_core.react.ICodeBlock","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.IColumnBlock","path":"/docs/api/interfaces/headstartwp_core.react.IColumnBlock","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.IColumnsBlock","path":"/docs/api/interfaces/headstartwp_core.react.IColumnsBlock","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.ICoverBlock","path":"/docs/api/interfaces/headstartwp_core.react.ICoverBlock","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.IDataWPBlock","path":"/docs/api/interfaces/headstartwp_core.react.IDataWPBlock","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.IFileBlock","path":"/docs/api/interfaces/headstartwp_core.react.IFileBlock","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.IGroupBlock","path":"/docs/api/interfaces/headstartwp_core.react.IGroupBlock","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.IHeadingBlock","path":"/docs/api/interfaces/headstartwp_core.react.IHeadingBlock","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.IImageBlock","path":"/docs/api/interfaces/headstartwp_core.react.IImageBlock","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.IListBlock","path":"/docs/api/interfaces/headstartwp_core.react.IListBlock","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.ImageBlockProps","path":"/docs/api/interfaces/headstartwp_core.react.ImageBlockProps","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.IMediaTextBlock","path":"/docs/api/interfaces/headstartwp_core.react.IMediaTextBlock","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.IParagraphBlock","path":"/docs/api/interfaces/headstartwp_core.react.IParagraphBlock","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.IPreformattedBlock","path":"/docs/api/interfaces/headstartwp_core.react.IPreformattedBlock","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.IPullQuoteBlock","path":"/docs/api/interfaces/headstartwp_core.react.IPullQuoteBlock","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.IQuoteBlock","path":"/docs/api/interfaces/headstartwp_core.react.IQuoteBlock","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.ISeparatorBlock","path":"/docs/api/interfaces/headstartwp_core.react.ISeparatorBlock","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.ISpacerBlock","path":"/docs/api/interfaces/headstartwp_core.react.ISpacerBlock","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.ITableBlock","path":"/docs/api/interfaces/headstartwp_core.react.ITableBlock","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.IVerseBlock","path":"/docs/api/interfaces/headstartwp_core.react.IVerseBlock","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.IYoutubeLiteBlock","path":"/docs/api/interfaces/headstartwp_core.react.IYoutubeLiteBlock","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.ListBlockProps","path":"/docs/api/interfaces/headstartwp_core.react.ListBlockProps","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.MediaTextBlockProps","path":"/docs/api/interfaces/headstartwp_core.react.MediaTextBlockProps","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.ParagraphBlockProps","path":"/docs/api/interfaces/headstartwp_core.react.ParagraphBlockProps","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.PreformattedBlockProps","path":"/docs/api/interfaces/headstartwp_core.react.PreformattedBlockProps","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.PullQuoteBlockProps","path":"/docs/api/interfaces/headstartwp_core.react.PullQuoteBlockProps","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.QuoteBlockProps","path":"/docs/api/interfaces/headstartwp_core.react.QuoteBlockProps","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.SafeHtmlProps","path":"/docs/api/interfaces/headstartwp_core.react.SafeHtmlProps","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.SeparatorBlockProps","path":"/docs/api/interfaces/headstartwp_core.react.SeparatorBlockProps","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties","path":"/docs/api/interfaces/headstartwp_core.react.SettingsCustomAdditionalProperties","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.SettingsProperties","path":"/docs/api/interfaces/headstartwp_core.react.SettingsProperties","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.SpacerBlockProps","path":"/docs/api/interfaces/headstartwp_core.react.SpacerBlockProps","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.StylesElementsPropertiesComplete","path":"/docs/api/interfaces/headstartwp_core.react.StylesElementsPropertiesComplete","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.StylesProperties","path":"/docs/api/interfaces/headstartwp_core.react.StylesProperties","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.TableBlockProps","path":"/docs/api/interfaces/headstartwp_core.react.TableBlockProps","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.Typography","path":"/docs/api/interfaces/headstartwp_core.react.Typography","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.useAppSettingsResponse","path":"/docs/api/interfaces/headstartwp_core.react.useAppSettingsResponse","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.useFetchOptions","path":"/docs/api/interfaces/headstartwp_core.react.useFetchOptions","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.useMenuResponse","path":"/docs/api/interfaces/headstartwp_core.react.useMenuResponse","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.usePostOrPostResponse","path":"/docs/api/interfaces/headstartwp_core.react.usePostOrPostResponse","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.usePostResponse","path":"/docs/api/interfaces/headstartwp_core.react.usePostResponse","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.usePostsResponse","path":"/docs/api/interfaces/headstartwp_core.react.usePostsResponse","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.useSearchNativeResponse","path":"/docs/api/interfaces/headstartwp_core.react.useSearchNativeResponse","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.useSearchResponse","path":"/docs/api/interfaces/headstartwp_core.react.useSearchResponse","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.useTermsResponse","path":"/docs/api/interfaces/headstartwp_core.react.useTermsResponse","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.VerseBlockProps","path":"/docs/api/interfaces/headstartwp_core.react.VerseBlockProps","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.WpThemeJSON","path":"/docs/api/interfaces/headstartwp_core.react.WpThemeJSON","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.react.YoutubeLiteBlockProps","path":"/docs/api/interfaces/headstartwp_core.react.YoutubeLiteBlockProps","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.Rendered","path":"/docs/api/interfaces/headstartwp_core.Rendered","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.RevisionEntity","path":"/docs/api/interfaces/headstartwp_core.RevisionEntity","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.SearchEntity","path":"/docs/api/interfaces/headstartwp_core.SearchEntity","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.SearchObjectEntity","path":"/docs/api/interfaces/headstartwp_core.SearchObjectEntity","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.SearchParams","path":"/docs/api/interfaces/headstartwp_core.SearchParams","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.TaxonomyArchiveParams","path":"/docs/api/interfaces/headstartwp_core.TaxonomyArchiveParams","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.TaxonomyEntity","path":"/docs/api/interfaces/headstartwp_core.TaxonomyEntity","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.TermEntity","path":"/docs/api/interfaces/headstartwp_core.TermEntity","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.TermSearchEntity","path":"/docs/api/interfaces/headstartwp_core.TermSearchEntity","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.TypeEntity","path":"/docs/api/interfaces/headstartwp_core.TypeEntity","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.VerifyTokenParams","path":"/docs/api/interfaces/headstartwp_core.VerifyTokenParams","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_core.YoastSEOIntegration","path":"/docs/api/interfaces/headstartwp_core.YoastSEOIntegration","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_next.FetchHookDataOptions","path":"/docs/api/interfaces/headstartwp_next.FetchHookDataOptions","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_next.ImageProps","path":"/docs/api/interfaces/headstartwp_next.ImageProps","sidebar":"tutorialSidebar"},{"id":"interfaces/headstartwp_next.LinkBlockProps","path":"/docs/api/interfaces/headstartwp_next.LinkBlockProps","sidebar":"tutorialSidebar"},{"id":"modules/headstartwp_core","path":"/docs/api/modules/headstartwp_core","sidebar":"tutorialSidebar"},{"id":"modules/headstartwp_next","path":"/docs/api/modules/headstartwp_next","sidebar":"tutorialSidebar"},{"id":"namespaces/headstartwp_core.react","path":"/docs/api/namespaces/headstartwp_core.react","sidebar":"tutorialSidebar"},{"id":"namespaces/headstartwp_next.config","path":"/docs/api/namespaces/headstartwp_next.config","sidebar":"tutorialSidebar"},{"id":"namespaces/headstartwp_next.middlewares","path":"/docs/api/namespaces/headstartwp_next.middlewares","sidebar":"tutorialSidebar"}],"draftIds":[],"sidebars":{"tutorialSidebar":{"link":{"path":"/docs/api/","label":"Table of Contents"}}}}],"breadcrumbs":true},"default":{"path":"/docs/learn","versions":[{"name":"current","label":"Next","isLast":true,"path":"/docs/learn","mainDocId":"index","docs":[{"id":"Data Fetching/custom-hooks","path":"/docs/learn/data-fetching/creating-your-own-custom-hooks","sidebar":"tutorialSidebar"},{"id":"Data Fetching/introduction","path":"/docs/learn/data-fetching","sidebar":"tutorialSidebar"},{"id":"Data Fetching/prefetching-data-server","path":"/docs/learn/data-fetching/prefetching","sidebar":"tutorialSidebar"},{"id":"Data Fetching/useAuthorArchive","path":"/docs/learn/data-fetching/useauthorarchive","sidebar":"tutorialSidebar"},{"id":"Data Fetching/usePost","path":"/docs/learn/data-fetching/usepost","sidebar":"tutorialSidebar"},{"id":"Data Fetching/usePostOrPosts","path":"/docs/learn/data-fetching/use-post-or-posts","sidebar":"tutorialSidebar"},{"id":"Data Fetching/usePosts","path":"/docs/learn/data-fetching/useposts","sidebar":"tutorialSidebar"},{"id":"Data Fetching/useSearch","path":"/docs/learn/data-fetching/usesearch","sidebar":"tutorialSidebar"},{"id":"Data Fetching/useSearchNative","path":"/docs/learn/data-fetching/usesearch-native","sidebar":"tutorialSidebar"},{"id":"Data Fetching/useSeo","path":"/docs/learn/data-fetching/useSeo","sidebar":"tutorialSidebar"},{"id":"Data Fetching/useTerms","path":"/docs/learn/data-fetching/useterms","sidebar":"tutorialSidebar"},{"id":"Getting Started/headless-config","path":"/docs/learn/getting-started/headless-config","sidebar":"tutorialSidebar"},{"id":"Getting Started/quick-setup","path":"/docs/learn/getting-started/quick-setup","sidebar":"tutorialSidebar"},{"id":"Getting Started/quick-tutorial","path":"/docs/learn/getting-started/quick-tutorial","sidebar":"tutorialSidebar"},{"id":"Getting Started/setting-up-manually","path":"/docs/learn/getting-started/setting-up-manually","sidebar":"tutorialSidebar"},{"id":"Getting Started/wordpress-plugin","path":"/docs/learn/getting-started/installing-wordpress-plugin","sidebar":"tutorialSidebar"},{"id":"Guides/ab-test-link","path":"/docs/learn/Guides/ab-test-link","sidebar":"tutorialSidebar"},{"id":"Guides/linaria","path":"/docs/learn/Guides/linaria","sidebar":"tutorialSidebar"},{"id":"Guides/typescript","path":"/docs/learn/Guides/typescript","sidebar":"tutorialSidebar"},{"id":"Guides/youtube-facade","path":"/docs/learn/Guides/youtube-facade","sidebar":"tutorialSidebar"},{"id":"Gutenberg/rendering-blocks","path":"/docs/learn/gutenberg/rendering-blocks","sidebar":"tutorialSidebar"},{"id":"Gutenberg/rendering-blocks-in-react-native","path":"/docs/learn/gutenberg/rendering-blocks-in-react-native","sidebar":"tutorialSidebar"},{"id":"Gutenberg/rendering-custom-blocks","path":"/docs/learn/gutenberg/rendering-custom-blocks","sidebar":"tutorialSidebar"},{"id":"index","path":"/docs/learn/","sidebar":"tutorialSidebar"},{"id":"Utilities/sanitization","path":"/docs/learn/utilities/sanitization","sidebar":"tutorialSidebar"},{"id":"WordPress Integration/basic-auth","path":"/docs/learn/wordpress-integration/basic-auth","sidebar":"tutorialSidebar"},{"id":"WordPress Integration/feeds","path":"/docs/learn/wordpress-integration/feeds","sidebar":"tutorialSidebar"},{"id":"WordPress Integration/gutenberg","path":"/docs/learn/wordpress-integration/gutenberg","sidebar":"tutorialSidebar"},{"id":"WordPress Integration/multisite","path":"/docs/learn/wordpress-integration/multisite","sidebar":"tutorialSidebar"},{"id":"WordPress Integration/polylang","path":"/docs/learn/wordpress-integration/polylang","sidebar":"tutorialSidebar"},{"id":"WordPress Integration/previews","path":"/docs/learn/wordpress-integration/previews","sidebar":"tutorialSidebar"},{"id":"WordPress Integration/revalidate","path":"/docs/learn/wordpress-integration/revalidate","sidebar":"tutorialSidebar"}],"draftIds":[],"sidebars":{"tutorialSidebar":{"link":{"path":"/docs/learn/","label":"Introduction"}}}}],"breadcrumbs":true}}}'),i=JSON.parse('{"defaultLocale":"en","locales":["en"],"path":"i18n","currentLocale":"en","localeConfigs":{"en":{"label":"English","direction":"ltr","htmlLang":"en","calendar":"gregory","path":"en"}}}');var s=n(7529);const c=JSON.parse('{"docusaurusVersion":"2.3.1","siteVersion":"0.0.0","pluginVersions":{"docusaurus-plugin-content-pages":{"type":"package","name":"@docusaurus/plugin-content-pages","version":"2.3.1"},"docusaurus-plugin-google-gtag":{"type":"package","name":"@docusaurus/plugin-google-gtag","version":"2.3.1"},"docusaurus-plugin-sitemap":{"type":"package","name":"@docusaurus/plugin-sitemap","version":"2.3.1"},"docusaurus-theme-classic":{"type":"package","name":"@docusaurus/theme-classic","version":"2.3.1"},"docusaurus-plugin-typedoc":{"type":"package","name":"docusaurus-plugin-typedoc","version":"0.18.0"},"docusaurus-plugin-content-docs":{"type":"package","name":"@docusaurus/plugin-content-docs","version":"2.3.1"},"@easyops-cn/docusaurus-search-local":{"type":"package","name":"@easyops-cn/docusaurus-search-local","version":"0.33.6"}}}'),l={siteConfig:a.default,siteMetadata:c,globalData:o,i18n:i,codeTranslations:s},u=r.createContext(l);function d(e){let{children:t}=e;return r.createElement(u.Provider,{value:l},t)}},4763:(e,t,n)=>{"use strict";n.d(t,{Z:()=>u});var r=n(7294),a=n(412),o=n(5742),i=n(3999);function s(e){let{error:t,tryAgain:n}=e;return r.createElement("div",{style:{display:"flex",flexDirection:"column",justifyContent:"center",alignItems:"center",height:"50vh",width:"100%",fontSize:"20px"}},r.createElement("h1",null,"This page crashed."),r.createElement("p",null,t.message),r.createElement("button",{type:"button",onClick:n},"Try again"))}function c(e){let{error:t,tryAgain:n}=e;return r.createElement(u,{fallback:()=>r.createElement(s,{error:t,tryAgain:n})},r.createElement(o.Z,null,r.createElement("title",null,"Page Error")),r.createElement(i.Z,null,r.createElement(s,{error:t,tryAgain:n})))}const l=e=>r.createElement(c,e);class u extends r.Component{constructor(e){super(e),this.state={error:null}}componentDidCatch(e){a.Z.canUseDOM&&this.setState({error:e})}render(){const{children:e}=this.props,{error:t}=this.state;if(t){const e={error:t,tryAgain:()=>this.setState({error:null})};return(this.props.fallback??l)(e)}return e??null}}},412:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});const r="undefined"!=typeof window&&"document"in window&&"createElement"in window.document,a={canUseDOM:r,canUseEventListeners:r&&("addEventListener"in window||"attachEvent"in window),canUseIntersectionObserver:r&&"IntersectionObserver"in window,canUseViewport:r&&"screen"in window}},5742:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(7294),a=n(405);function o(e){return r.createElement(a.ql,e)}},9960:(e,t,n)=>{"use strict";n.d(t,{Z:()=>f});var r=n(7462),a=n(7294),o=n(3727),i=n(8780),s=n(2263),c=n(3919),l=n(412);const u=a.createContext({collectLink:()=>{}});var d=n(4996);function p(e,t){let{isNavLink:n,to:p,href:f,activeClassName:h,isActive:m,"data-noBrokenLinkCheck":g,autoAddBaseUrl:b=!0,...y}=e;const{siteConfig:{trailingSlash:v,baseUrl:w}}=(0,s.Z)(),{withBaseUrl:_}=(0,d.C)(),k=(0,a.useContext)(u),S=(0,a.useRef)(null);(0,a.useImperativeHandle)(t,(()=>S.current));const E=p||f;const x=(0,c.Z)(E),P=E?.replace("pathname://","");let T=void 0!==P?(C=P,b&&(e=>e.startsWith("/"))(C)?_(C):C):void 0;var C;T&&x&&(T=(0,i.applyTrailingSlash)(T,{trailingSlash:v,baseUrl:w}));const I=(0,a.useRef)(!1),A=n?o.OL:o.rU,O=l.Z.canUseIntersectionObserver,L=(0,a.useRef)(),N=()=>{I.current||null==T||(window.docusaurus.preload(T),I.current=!0)};(0,a.useEffect)((()=>(!O&&x&&null!=T&&window.docusaurus.prefetch(T),()=>{O&&L.current&&L.current.disconnect()})),[L,T,O,x]);const R=T?.startsWith("#")??!1,B=!T||!x||R;return B||g||k.collectLink(T),B?a.createElement("a",(0,r.Z)({ref:S,href:T},E&&!x&&{target:"_blank",rel:"noopener noreferrer"},y)):a.createElement(A,(0,r.Z)({},y,{onMouseEnter:N,onTouchStart:N,innerRef:e=>{S.current=e,O&&e&&x&&(L.current=new window.IntersectionObserver((t=>{t.forEach((t=>{e===t.target&&(t.isIntersecting||t.intersectionRatio>0)&&(L.current.unobserve(e),L.current.disconnect(),null!=T&&window.docusaurus.prefetch(T))}))})),L.current.observe(e))},to:T},n&&{isActive:m,activeClassName:h}))}const f=a.forwardRef(p)},5999:(e,t,n)=>{"use strict";n.d(t,{Z:()=>c,I:()=>s});var r=n(7294);function a(e,t){const n=e.split(/(\{\w+\})/).map(((e,n)=>{if(n%2==1){const n=t?.[e.slice(1,-1)];if(void 0!==n)return n}return e}));return n.some((e=>(0,r.isValidElement)(e)))?n.map(((e,t)=>(0,r.isValidElement)(e)?r.cloneElement(e,{key:t}):e)).filter((e=>""!==e)):n.join("")}var o=n(7529);function i(e){let{id:t,message:n}=e;if(void 0===t&&void 0===n)throw new Error("Docusaurus translation declarations must have at least a translation id or a default translation message");return o[t??n]??n??t}function s(e,t){let{message:n,id:r}=e;return a(i({message:n,id:r}),t)}function c(e){let{children:t,id:n,values:o}=e;if(t&&"string"!=typeof t)throw console.warn("Illegal children",t),new Error("The Docusaurus component only accept simple string values");const s=i({message:t,id:n});return r.createElement(r.Fragment,null,a(s,o))}},9935:(e,t,n)=>{"use strict";n.d(t,{m:()=>r});const r="default"},3919:(e,t,n)=>{"use strict";function r(e){return/^(?:\w*:|\/\/)/.test(e)}function a(e){return void 0!==e&&!r(e)}n.d(t,{Z:()=>a,b:()=>r})},4996:(e,t,n)=>{"use strict";n.d(t,{C:()=>i,Z:()=>s});var r=n(7294),a=n(2263),o=n(3919);function i(){const{siteConfig:{baseUrl:e,url:t}}=(0,a.Z)(),n=(0,r.useCallback)(((n,r)=>function(e,t,n,r){let{forcePrependBaseUrl:a=!1,absolute:i=!1}=void 0===r?{}:r;if(!n||n.startsWith("#")||(0,o.b)(n))return n;if(a)return t+n.replace(/^\//,"");if(n===t.replace(/\/$/,""))return t;const s=n.startsWith(t)?n:t+n.replace(/^\//,"");return i?e+s:s}(t,e,n,r)),[t,e]);return{withBaseUrl:n}}function s(e,t){void 0===t&&(t={});const{withBaseUrl:n}=i();return n(e,t)}},2263:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(7294),a=n(8940);function o(){return(0,r.useContext)(a._)}},2389:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(7294),a=n(8934);function o(){return(0,r.useContext)(a._)}},9670:(e,t,n)=>{"use strict";n.d(t,{Z:()=>r});function r(e){const t={};return function e(n,r){Object.entries(n).forEach((n=>{let[a,o]=n;const i=r?`${r}.${a}`:a;var s;"object"==typeof(s=o)&&s&&Object.keys(s).length>0?e(o,i):t[i]=o}))}(e),t}},226:(e,t,n)=>{"use strict";n.d(t,{_:()=>a,z:()=>o});var r=n(7294);const a=r.createContext(null);function o(e){let{children:t,value:n}=e;const o=r.useContext(a),i=(0,r.useMemo)((()=>function(e){let{parent:t,value:n}=e;if(!t){if(!n)throw new Error("Unexpected: no Docusaurus route context found");if(!("plugin"in n))throw new Error("Unexpected: Docusaurus topmost route context has no `plugin` attribute");return n}const r={...t.data,...n?.data};return{plugin:t.plugin,data:r}}({parent:o,value:n})),[o,n]);return r.createElement(a.Provider,{value:i},t)}},143:(e,t,n)=>{"use strict";n.d(t,{Iw:()=>m,gA:()=>p,_r:()=>u,Jo:()=>g,zh:()=>d,yW:()=>h,gB:()=>f});var r=n(6550),a=n(2263),o=n(9935);function i(e,t){void 0===t&&(t={});const n=function(){const{globalData:e}=(0,a.Z)();return e}()[e];if(!n&&t.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin.`);return n}const s=e=>e.versions.find((e=>e.isLast));function c(e,t){const n=function(e,t){const n=s(e);return[...e.versions.filter((e=>e!==n)),n].find((e=>!!(0,r.LX)(t,{path:e.path,exact:!1,strict:!1})))}(e,t),a=n?.docs.find((e=>!!(0,r.LX)(t,{path:e.path,exact:!0,strict:!1})));return{activeVersion:n,activeDoc:a,alternateDocVersions:a?function(t){const n={};return e.versions.forEach((e=>{e.docs.forEach((r=>{r.id===t&&(n[e.name]=r)}))})),n}(a.id):{}}}const l={},u=()=>i("docusaurus-plugin-content-docs")??l,d=e=>function(e,t,n){void 0===t&&(t=o.m),void 0===n&&(n={});const r=i(e)?.[t];if(!r&&n.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin with id "${t}".`);return r}("docusaurus-plugin-content-docs",e,{failfast:!0});function p(e){void 0===e&&(e={});const t=u(),{pathname:n}=(0,r.TH)();return function(e,t,n){void 0===n&&(n={});const a=Object.entries(e).sort(((e,t)=>t[1].path.localeCompare(e[1].path))).find((e=>{let[,n]=e;return!!(0,r.LX)(t,{path:n.path,exact:!1,strict:!1})})),o=a?{pluginId:a[0],pluginData:a[1]}:void 0;if(!o&&n.failfast)throw new Error(`Can't find active docs plugin for "${t}" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: ${Object.values(e).map((e=>e.path)).join(", ")}`);return o}(t,n,e)}function f(e){return d(e).versions}function h(e){const t=d(e);return s(t)}function m(e){const t=d(e),{pathname:n}=(0,r.TH)();return c(t,n)}function g(e){const t=d(e),{pathname:n}=(0,r.TH)();return function(e,t){const n=s(e);return{latestDocSuggestion:c(e,t).alternateDocVersions[n.name],latestVersionSuggestion:n}}(t,n)}},6657:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>r});const r={onRouteDidUpdate(e){let{location:t,previousLocation:n}=e;!n||t.pathname===n.pathname&&t.search===n.search&&t.hash===n.hash||setTimeout((()=>{window.gtag("event","page_view",{page_title:document.title,page_location:window.location.href,page_path:t.pathname+t.search+t.hash})}))}}},8320:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>o});var r=n(4865),a=n.n(r);a().configure({showSpinner:!1});const o={onRouteUpdate(e){let{location:t,previousLocation:n}=e;if(n&&t.pathname!==n.pathname){const e=window.setTimeout((()=>{a().start()}),200);return()=>window.clearTimeout(e)}},onRouteDidUpdate(){a().done()}}},3310:(e,t,n)=>{"use strict";n.r(t);var r=n(7410),a=n(6809);!function(e){const{themeConfig:{prism:t}}=a.default,{additionalLanguages:r}=t;globalThis.Prism=e,r.forEach((e=>{n(5873)(`./prism-${e}`)})),delete globalThis.Prism}(r.Z)},9471:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(7294);const a="iconExternalLink_nPIU";function o(e){let{width:t=13.5,height:n=13.5}=e;return r.createElement("svg",{width:t,height:n,"aria-hidden":"true",viewBox:"0 0 24 24",className:a},r.createElement("path",{fill:"currentColor",d:"M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"}))}},3999:(e,t,n)=>{"use strict";n.d(t,{Z:()=>lt});var r=n(7294),a=n(6010),o=n(4763),i=n(1944),s=n(7462),c=n(6550),l=n(5999),u=n(5936);const d="docusaurus_skipToContent_fallback";function p(e){e.setAttribute("tabindex","-1"),e.focus(),e.removeAttribute("tabindex")}function f(){const e=(0,r.useRef)(null),{action:t}=(0,c.k6)(),n=(0,r.useCallback)((e=>{e.preventDefault();const t=document.querySelector("main:first-of-type")??document.getElementById(d);t&&p(t)}),[]);return(0,u.S)((n=>{let{location:r}=n;e.current&&!r.hash&&"PUSH"===t&&p(e.current)})),{containerRef:e,onClick:n}}const h=(0,l.I)({id:"theme.common.skipToMainContent",description:"The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation",message:"Skip to main content"});function m(e){const t=e.children??h,{containerRef:n,onClick:a}=f();return r.createElement("div",{ref:n,role:"region","aria-label":h},r.createElement("a",(0,s.Z)({},e,{href:`#${d}`,onClick:a}),t))}var g=n(5281),b=n(9727);const y="skipToContent_fXgn";function v(){return r.createElement(m,{className:y})}var w=n(6668),_=n(9689);function k(e){let{width:t=21,height:n=21,color:a="currentColor",strokeWidth:o=1.2,className:i,...c}=e;return r.createElement("svg",(0,s.Z)({viewBox:"0 0 15 15",width:t,height:n},c),r.createElement("g",{stroke:a,strokeWidth:o},r.createElement("path",{d:"M.75.75l13.5 13.5M14.25.75L.75 14.25"})))}const S="closeButton_CVFx";function E(e){return r.createElement("button",(0,s.Z)({type:"button","aria-label":(0,l.I)({id:"theme.AnnouncementBar.closeButtonAriaLabel",message:"Close",description:"The ARIA label for close button of announcement bar"})},e,{className:(0,a.Z)("clean-btn close",S,e.className)}),r.createElement(k,{width:14,height:14,strokeWidth:3.1}))}const x="content_knG7";function P(e){const{announcementBar:t}=(0,w.L)(),{content:n}=t;return r.createElement("div",(0,s.Z)({},e,{className:(0,a.Z)(x,e.className),dangerouslySetInnerHTML:{__html:n}}))}const T="announcementBar_mb4j",C="announcementBarPlaceholder_vyr4",I="announcementBarClose_gvF7",A="announcementBarContent_xLdY";function O(){const{announcementBar:e}=(0,w.L)(),{isActive:t,close:n}=(0,_.nT)();if(!t)return null;const{backgroundColor:a,textColor:o,isCloseable:i}=e;return r.createElement("div",{className:T,style:{backgroundColor:a,color:o},role:"banner"},i&&r.createElement("div",{className:C}),r.createElement(P,{className:A}),i&&r.createElement(E,{onClick:n,className:I}))}var L=n(2961),N=n(2466);var R=n(902),B=n(3102);const F=r.createContext(null);function D(e){let{children:t}=e;const n=function(){const e=(0,L.e)(),t=(0,B.HY)(),[n,a]=(0,r.useState)(!1),o=null!==t.component,i=(0,R.D9)(o);return(0,r.useEffect)((()=>{o&&!i&&a(!0)}),[o,i]),(0,r.useEffect)((()=>{o?e.shown||a(!0):a(!1)}),[e.shown,o]),(0,r.useMemo)((()=>[n,a]),[n])}();return r.createElement(F.Provider,{value:n},t)}function M(e){if(e.component){const t=e.component;return r.createElement(t,e.props)}}function $(){const e=(0,r.useContext)(F);if(!e)throw new R.i6("NavbarSecondaryMenuDisplayProvider");const[t,n]=e,a=(0,r.useCallback)((()=>n(!1)),[n]),o=(0,B.HY)();return(0,r.useMemo)((()=>({shown:t,hide:a,content:M(o)})),[a,o,t])}function z(e){let{header:t,primaryMenu:n,secondaryMenu:o}=e;const{shown:i}=$();return r.createElement("div",{className:"navbar-sidebar"},t,r.createElement("div",{className:(0,a.Z)("navbar-sidebar__items",{"navbar-sidebar__items--show-secondary":i})},r.createElement("div",{className:"navbar-sidebar__item menu"},n),r.createElement("div",{className:"navbar-sidebar__item menu"},o)))}var U=n(2949),j=n(2389);function H(e){return r.createElement("svg",(0,s.Z)({viewBox:"0 0 24 24",width:24,height:24},e),r.createElement("path",{fill:"currentColor",d:"M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"}))}function G(e){return r.createElement("svg",(0,s.Z)({viewBox:"0 0 24 24",width:24,height:24},e),r.createElement("path",{fill:"currentColor",d:"M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"}))}const Z={toggle:"toggle_vylO",toggleButton:"toggleButton_gllP",darkToggleIcon:"darkToggleIcon_wfgR",lightToggleIcon:"lightToggleIcon_pyhR",toggleButtonDisabled:"toggleButtonDisabled_aARS"};function Q(e){let{className:t,value:n,onChange:o}=e;const i=(0,j.Z)(),s=(0,l.I)({message:"Switch between dark and light mode (currently {mode})",id:"theme.colorToggle.ariaLabel",description:"The ARIA label for the navbar color mode toggle"},{mode:"dark"===n?(0,l.I)({message:"dark mode",id:"theme.colorToggle.ariaLabel.mode.dark",description:"The name for the dark color mode"}):(0,l.I)({message:"light mode",id:"theme.colorToggle.ariaLabel.mode.light",description:"The name for the light color mode"})});return r.createElement("div",{className:(0,a.Z)(Z.toggle,t)},r.createElement("button",{className:(0,a.Z)("clean-btn",Z.toggleButton,!i&&Z.toggleButtonDisabled),type:"button",onClick:()=>o("dark"===n?"light":"dark"),disabled:!i,title:s,"aria-label":s,"aria-live":"polite"},r.createElement(H,{className:(0,a.Z)(Z.toggleIcon,Z.lightToggleIcon)}),r.createElement(G,{className:(0,a.Z)(Z.toggleIcon,Z.darkToggleIcon)})))}const V=r.memo(Q);function W(e){let{className:t}=e;const n=(0,w.L)().colorMode.disableSwitch,{colorMode:a,setColorMode:o}=(0,U.I)();return n?null:r.createElement(V,{className:t,value:a,onChange:o})}var q=n(1327);function Y(){return r.createElement(q.Z,{className:"navbar__brand",imageClassName:"navbar__logo",titleClassName:"navbar__title text--truncate"})}function K(){const e=(0,L.e)();return r.createElement("button",{type:"button","aria-label":(0,l.I)({id:"theme.docs.sidebar.closeSidebarButtonAriaLabel",message:"Close navigation bar",description:"The ARIA label for close button of mobile sidebar"}),className:"clean-btn navbar-sidebar__close",onClick:()=>e.toggle()},r.createElement(k,{color:"var(--ifm-color-emphasis-600)"}))}function X(){return r.createElement("div",{className:"navbar-sidebar__brand"},r.createElement(Y,null),r.createElement(W,{className:"margin-right--md"}),r.createElement(K,null))}var J=n(9960),ee=n(4996),te=n(3919);function ne(e,t){return void 0!==e&&void 0!==t&&new RegExp(e,"gi").test(t)}var re=n(9471);function ae(e){let{activeBasePath:t,activeBaseRegex:n,to:a,href:o,label:i,html:c,isDropdownLink:l,prependBaseUrlToHref:u,...d}=e;const p=(0,ee.Z)(a),f=(0,ee.Z)(t),h=(0,ee.Z)(o,{forcePrependBaseUrl:!0}),m=i&&o&&!(0,te.Z)(o),g=c?{dangerouslySetInnerHTML:{__html:c}}:{children:r.createElement(r.Fragment,null,i,m&&r.createElement(re.Z,l&&{width:12,height:12}))};return o?r.createElement(J.Z,(0,s.Z)({href:u?h:o},d,g)):r.createElement(J.Z,(0,s.Z)({to:p,isNavLink:!0},(t||n)&&{isActive:(e,t)=>n?ne(n,t.pathname):t.pathname.startsWith(f)},d,g))}function oe(e){let{className:t,isDropdownItem:n=!1,...o}=e;const i=r.createElement(ae,(0,s.Z)({className:(0,a.Z)(n?"dropdown__link":"navbar__item navbar__link",t),isDropdownLink:n},o));return n?r.createElement("li",null,i):i}function ie(e){let{className:t,isDropdownItem:n,...o}=e;return r.createElement("li",{className:"menu__list-item"},r.createElement(ae,(0,s.Z)({className:(0,a.Z)("menu__link",t)},o)))}function se(e){let{mobile:t=!1,position:n,...a}=e;const o=t?ie:oe;return r.createElement(o,(0,s.Z)({},a,{activeClassName:a.activeClassName??(t?"menu__link--active":"navbar__link--active")}))}var ce=n(6043),le=n(8596),ue=n(2263);function de(e,t){return e.some((e=>function(e,t){return!!(0,le.Mg)(e.to,t)||!!ne(e.activeBaseRegex,t)||!(!e.activeBasePath||!t.startsWith(e.activeBasePath))}(e,t)))}function pe(e){let{items:t,position:n,className:o,onClick:i,...c}=e;const l=(0,r.useRef)(null),[u,d]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{const e=e=>{l.current&&!l.current.contains(e.target)&&d(!1)};return document.addEventListener("mousedown",e),document.addEventListener("touchstart",e),()=>{document.removeEventListener("mousedown",e),document.removeEventListener("touchstart",e)}}),[l]),r.createElement("div",{ref:l,className:(0,a.Z)("navbar__item","dropdown","dropdown--hoverable",{"dropdown--right":"right"===n,"dropdown--show":u})},r.createElement(ae,(0,s.Z)({"aria-haspopup":"true","aria-expanded":u,role:"button",href:c.to?void 0:"#",className:(0,a.Z)("navbar__link",o)},c,{onClick:c.to?void 0:e=>e.preventDefault(),onKeyDown:e=>{"Enter"===e.key&&(e.preventDefault(),d(!u))}}),c.children??c.label),r.createElement("ul",{className:"dropdown__menu"},t.map(((e,n)=>r.createElement(Pe,(0,s.Z)({isDropdownItem:!0,onKeyDown:e=>{if(n===t.length-1&&"Tab"===e.key){e.preventDefault(),d(!1);const t=l.current.nextElementSibling;if(t){(t instanceof HTMLAnchorElement?t:t.querySelector("a")).focus()}}},activeClassName:"dropdown__link--active"},e,{key:n}))))))}function fe(e){let{items:t,className:n,position:o,onClick:i,...l}=e;const u=function(){const{siteConfig:{baseUrl:e}}=(0,ue.Z)(),{pathname:t}=(0,c.TH)();return t.replace(e,"/")}(),d=de(t,u),{collapsed:p,toggleCollapsed:f,setCollapsed:h}=(0,ce.u)({initialState:()=>!d});return(0,r.useEffect)((()=>{d&&h(!d)}),[u,d,h]),r.createElement("li",{className:(0,a.Z)("menu__list-item",{"menu__list-item--collapsed":p})},r.createElement(ae,(0,s.Z)({role:"button",className:(0,a.Z)("menu__link menu__link--sublist menu__link--sublist-caret",n)},l,{onClick:e=>{e.preventDefault(),f()}}),l.children??l.label),r.createElement(ce.z,{lazy:!0,as:"ul",className:"menu__list",collapsed:p},t.map(((e,t)=>r.createElement(Pe,(0,s.Z)({mobile:!0,isDropdownItem:!0,onClick:i,activeClassName:"menu__link--active"},e,{key:t}))))))}function he(e){let{mobile:t=!1,...n}=e;const a=t?fe:pe;return r.createElement(a,n)}var me=n(4711);function ge(e){let{width:t=20,height:n=20,...a}=e;return r.createElement("svg",(0,s.Z)({viewBox:"0 0 24 24",width:t,height:n,"aria-hidden":!0},a),r.createElement("path",{fill:"currentColor",d:"M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"}))}const be="iconLanguage_nlXk";var ye=n(7445);const ve="searchBox_ZlJk";function we(e){let{children:t,className:n}=e;return r.createElement("div",{className:(0,a.Z)(n,ve)},t)}var _e=n(143),ke=n(2802);var Se=n(373);const Ee=e=>e.docs.find((t=>t.id===e.mainDocId));const xe={default:se,localeDropdown:function(e){let{mobile:t,dropdownItemsBefore:n,dropdownItemsAfter:a,...o}=e;const{i18n:{currentLocale:i,locales:u,localeConfigs:d}}=(0,ue.Z)(),p=(0,me.l)(),{search:f,hash:h}=(0,c.TH)(),m=[...n,...u.map((e=>{const n=`${`pathname://${p.createUrl({locale:e,fullyQualified:!1})}`}${f}${h}`;return{label:d[e].label,lang:d[e].htmlLang,to:n,target:"_self",autoAddBaseUrl:!1,className:e===i?t?"menu__link--active":"dropdown__link--active":""}})),...a],g=t?(0,l.I)({message:"Languages",id:"theme.navbar.mobileLanguageDropdown.label",description:"The label for the mobile language switcher dropdown"}):d[i].label;return r.createElement(he,(0,s.Z)({},o,{mobile:t,label:r.createElement(r.Fragment,null,r.createElement(ge,{className:be}),g),items:m}))},search:function(e){let{mobile:t,className:n}=e;return t?null:r.createElement(we,{className:n},r.createElement(ye.Z,null))},dropdown:he,html:function(e){let{value:t,className:n,mobile:o=!1,isDropdownItem:i=!1}=e;const s=i?"li":"div";return r.createElement(s,{className:(0,a.Z)({navbar__item:!o&&!i,"menu__list-item":o},n),dangerouslySetInnerHTML:{__html:t}})},doc:function(e){let{docId:t,label:n,docsPluginId:a,...o}=e;const{activeDoc:i}=(0,_e.Iw)(a),c=(0,ke.vY)(t,a);return null===c?null:r.createElement(se,(0,s.Z)({exact:!0},o,{isActive:()=>i?.path===c.path||!!i?.sidebar&&i.sidebar===c.sidebar,label:n??c.id,to:c.path}))},docSidebar:function(e){let{sidebarId:t,label:n,docsPluginId:a,...o}=e;const{activeDoc:i}=(0,_e.Iw)(a),c=(0,ke.oz)(t,a).link;if(!c)throw new Error(`DocSidebarNavbarItem: Sidebar with ID "${t}" doesn't have anything to be linked to.`);return r.createElement(se,(0,s.Z)({exact:!0},o,{isActive:()=>i?.sidebar===t,label:n??c.label,to:c.path}))},docsVersion:function(e){let{label:t,to:n,docsPluginId:a,...o}=e;const i=(0,ke.lO)(a)[0],c=t??i.label,l=n??(e=>e.docs.find((t=>t.id===e.mainDocId)))(i).path;return r.createElement(se,(0,s.Z)({},o,{label:c,to:l}))},docsVersionDropdown:function(e){let{mobile:t,docsPluginId:n,dropdownActiveClassDisabled:a,dropdownItemsBefore:o,dropdownItemsAfter:i,...u}=e;const{search:d,hash:p}=(0,c.TH)(),f=(0,_e.Iw)(n),h=(0,_e.gB)(n),{savePreferredVersionName:m}=(0,Se.J)(n),g=[...o,...h.map((e=>{const t=f.alternateDocVersions[e.name]??Ee(e);return{label:e.label,to:`${t.path}${d}${p}`,isActive:()=>e===f.activeVersion,onClick:()=>m(e.name)}})),...i],b=(0,ke.lO)(n)[0],y=t&&g.length>1?(0,l.I)({id:"theme.navbar.mobileVersionsDropdown.label",message:"Versions",description:"The label for the navbar versions dropdown on mobile view"}):b.label,v=t&&g.length>1?void 0:Ee(b).path;return g.length<=1?r.createElement(se,(0,s.Z)({},u,{mobile:t,label:y,to:v,isActive:a?()=>!1:void 0})):r.createElement(he,(0,s.Z)({},u,{mobile:t,label:y,to:v,items:g,isActive:a?()=>!1:void 0}))}};function Pe(e){let{type:t,...n}=e;const a=function(e,t){return e&&"default"!==e?e:"items"in t?"dropdown":"default"}(t,n),o=xe[a];if(!o)throw new Error(`No NavbarItem component found for type "${t}".`);return r.createElement(o,n)}function Te(){const e=(0,L.e)(),t=(0,w.L)().navbar.items;return r.createElement("ul",{className:"menu__list"},t.map(((t,n)=>r.createElement(Pe,(0,s.Z)({mobile:!0},t,{onClick:()=>e.toggle(),key:n})))))}function Ce(e){return r.createElement("button",(0,s.Z)({},e,{type:"button",className:"clean-btn navbar-sidebar__back"}),r.createElement(l.Z,{id:"theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel",description:"The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)"},"\u2190 Back to main menu"))}function Ie(){const e=0===(0,w.L)().navbar.items.length,t=$();return r.createElement(r.Fragment,null,!e&&r.createElement(Ce,{onClick:()=>t.hide()}),t.content)}function Ae(){const e=(0,L.e)();var t;return void 0===(t=e.shown)&&(t=!0),(0,r.useEffect)((()=>(document.body.style.overflow=t?"hidden":"visible",()=>{document.body.style.overflow="visible"})),[t]),e.shouldRender?r.createElement(z,{header:r.createElement(X,null),primaryMenu:r.createElement(Te,null),secondaryMenu:r.createElement(Ie,null)}):null}const Oe="navbarHideable_m1mJ",Le="navbarHidden_jGov";function Ne(e){return r.createElement("div",(0,s.Z)({role:"presentation"},e,{className:(0,a.Z)("navbar-sidebar__backdrop",e.className)}))}function Re(e){let{children:t}=e;const{navbar:{hideOnScroll:n,style:o}}=(0,w.L)(),i=(0,L.e)(),{navbarRef:s,isNavbarVisible:c}=function(e){const[t,n]=(0,r.useState)(e),a=(0,r.useRef)(!1),o=(0,r.useRef)(0),i=(0,r.useCallback)((e=>{null!==e&&(o.current=e.getBoundingClientRect().height)}),[]);return(0,N.RF)(((t,r)=>{let{scrollY:i}=t;if(!e)return;if(i=s?n(!1):i+l{if(!e)return;const r=t.location.hash;if(r?document.getElementById(r.substring(1)):void 0)return a.current=!0,void n(!1);n(!0)})),{navbarRef:i,isNavbarVisible:t}}(n);return r.createElement("nav",{ref:s,"aria-label":(0,l.I)({id:"theme.NavBar.navAriaLabel",message:"Main",description:"The ARIA label for the main navigation"}),className:(0,a.Z)("navbar","navbar--fixed-top",n&&[Oe,!c&&Le],{"navbar--dark":"dark"===o,"navbar--primary":"primary"===o,"navbar-sidebar--show":i.shown})},t,r.createElement(Ne,{onClick:i.toggle}),r.createElement(Ae,null))}function Be(e){let{width:t=30,height:n=30,className:a,...o}=e;return r.createElement("svg",(0,s.Z)({className:a,width:t,height:n,viewBox:"0 0 30 30","aria-hidden":"true"},o),r.createElement("path",{stroke:"currentColor",strokeLinecap:"round",strokeMiterlimit:"10",strokeWidth:"2",d:"M4 7h22M4 15h22M4 23h22"}))}function Fe(){const{toggle:e,shown:t}=(0,L.e)();return r.createElement("button",{onClick:e,"aria-label":(0,l.I)({id:"theme.docs.sidebar.toggleSidebarButtonAriaLabel",message:"Toggle navigation bar",description:"The ARIA label for hamburger menu button of mobile navigation"}),"aria-expanded":t,className:"navbar__toggle clean-btn",type:"button"},r.createElement(Be,null))}const De="colorModeToggle_DEke";function Me(e){let{items:t}=e;return r.createElement(r.Fragment,null,t.map(((e,t)=>r.createElement(Pe,(0,s.Z)({},e,{key:t})))))}function $e(e){let{left:t,right:n}=e;return r.createElement("div",{className:"navbar__inner"},r.createElement("div",{className:"navbar__items"},t),r.createElement("div",{className:"navbar__items navbar__items--right"},n))}function ze(){const e=(0,L.e)(),t=(0,w.L)().navbar.items,[n,a]=function(e){function t(e){return"left"===(e.position??"right")}return[e.filter(t),e.filter((e=>!t(e)))]}(t),o=t.find((e=>"search"===e.type));return r.createElement($e,{left:r.createElement(r.Fragment,null,!e.disabled&&r.createElement(Fe,null),r.createElement(Y,null),r.createElement(Me,{items:n})),right:r.createElement(r.Fragment,null,r.createElement(Me,{items:a}),r.createElement(W,{className:De}),!o&&r.createElement(we,null,r.createElement(ye.Z,null)))})}function Ue(){return r.createElement(Re,null,r.createElement(ze,null))}function je(e){let{item:t}=e;const{to:n,href:a,label:o,prependBaseUrlToHref:i,...c}=t,l=(0,ee.Z)(n),u=(0,ee.Z)(a,{forcePrependBaseUrl:!0});return r.createElement(J.Z,(0,s.Z)({className:"footer__link-item"},a?{href:i?u:a}:{to:l},c),o,a&&!(0,te.Z)(a)&&r.createElement(re.Z,null))}function He(e){let{item:t}=e;return t.html?r.createElement("li",{className:"footer__item",dangerouslySetInnerHTML:{__html:t.html}}):r.createElement("li",{key:t.href??t.to,className:"footer__item"},r.createElement(je,{item:t}))}function Ge(e){let{column:t}=e;return r.createElement("div",{className:"col footer__col"},r.createElement("div",{className:"footer__title"},t.title),r.createElement("ul",{className:"footer__items clean-list"},t.items.map(((e,t)=>r.createElement(He,{key:t,item:e})))))}function Ze(e){let{columns:t}=e;return r.createElement("div",{className:"row footer__links"},t.map(((e,t)=>r.createElement(Ge,{key:t,column:e}))))}function Qe(){return r.createElement("span",{className:"footer__link-separator"},"\xb7")}function Ve(e){let{item:t}=e;return t.html?r.createElement("span",{className:"footer__link-item",dangerouslySetInnerHTML:{__html:t.html}}):r.createElement(je,{item:t})}function We(e){let{links:t}=e;return r.createElement("div",{className:"footer__links text--center"},r.createElement("div",{className:"footer__links"},t.map(((e,n)=>r.createElement(r.Fragment,{key:n},r.createElement(Ve,{item:e}),t.length!==n+1&&r.createElement(Qe,null))))))}function qe(e){let{links:t}=e;return function(e){return"title"in e[0]}(t)?r.createElement(Ze,{columns:t}):r.createElement(We,{links:t})}var Ye=n(941);const Ke="footerLogoLink_BH7S";function Xe(e){let{logo:t}=e;const{withBaseUrl:n}=(0,ee.C)(),o={light:n(t.src),dark:n(t.srcDark??t.src)};return r.createElement(Ye.Z,{className:(0,a.Z)("footer__logo",t.className),alt:t.alt,sources:o,width:t.width,height:t.height,style:t.style})}function Je(e){let{logo:t}=e;return t.href?r.createElement(J.Z,{href:t.href,className:Ke,target:t.target},r.createElement(Xe,{logo:t})):r.createElement(Xe,{logo:t})}function et(e){let{copyright:t}=e;return r.createElement("div",{className:"footer__copyright",dangerouslySetInnerHTML:{__html:t}})}function tt(e){let{style:t,links:n,logo:o,copyright:i}=e;return r.createElement("footer",{className:(0,a.Z)("footer",{"footer--dark":"dark"===t})},r.createElement("div",{className:"container container-fluid"},n,(o||i)&&r.createElement("div",{className:"footer__bottom text--center"},o&&r.createElement("div",{className:"margin-bottom--sm"},o),i)))}function nt(){const{footer:e}=(0,w.L)();if(!e)return null;const{copyright:t,links:n,logo:a,style:o}=e;return r.createElement(tt,{style:o,links:n&&n.length>0&&r.createElement(qe,{links:n}),logo:a&&r.createElement(Je,{logo:a}),copyright:t&&r.createElement(et,{copyright:t})})}const rt=r.memo(nt);function at(e){return r.createElement(r.Fragment,null,r.createElement(rt,e),r.createElement("div",{className:"footer-about"},r.createElement("div",{className:"footer-about-inner"},r.createElement("div",{className:"cta-careers"},"Interested in working on things like this?",r.createElement("br",null),r.createElement("a",{href:"https://10up.com/careers",className:"button"},"Careers at 10up")),r.createElement("div",{className:"license"},r.createElement("p",null,"Open source, MIT licensed.",r.createElement("br",null),r.createElement("span",{className:"copyright"},"Copyright \xa9 2023"))))),r.createElement("footer",{className:"footer-10up"},r.createElement("div",{className:"wrap"},r.createElement("a",{className:"tenup-logo",href:"https://10up.com",title:"10up"},r.createElement("img",{src:(0,ee.Z)("/img/10up-logo-full.svg"),alt:"10up logo",width:"75",height:"75"})),r.createElement("p",null,"Finely crafted by 10up, \xa92023."),r.createElement("div",{className:"social-media"},r.createElement("a",{href:"https://www.facebook.com/10up.agency",title:"10up on Facebook","aria-hidden":"true"},r.createElement("svg",{xmlns:"http://www.w3.org/2000/svg",viewBox:"0 0 32 32","aria-hidden":"true"},r.createElement("path",{d:"M16 0c8.837 0 16 7.163 16 16 0 8.159-6.107 14.892-14 15.876V20h5.5l.5-4h-6v-2a2 2 0 0 1 2-2h4V8h-4a6 6 0 0 0-6 6v2h-3v4h3v11.876C6.107 30.892 0 24.159 0 16 0 7.163 7.163 0 16 0z"}))),r.createElement("a",{href:"https://twitter.com/10up","aria-hidden":"true",title:"10up on Twitter"},r.createElement("svg",{xmlns:"http://www.w3.org/2000/svg",viewBox:"0 0 32 32","aria-hidden":"true"},r.createElement("path",{d:"M32 6.076a13.14 13.14 0 0 1-3.771 1.034 6.592 6.592 0 0 0 2.887-3.632 13.151 13.151 0 0 1-4.169 1.593 6.557 6.557 0 0 0-4.792-2.073 6.565 6.565 0 0 0-6.565 6.565c0 .515.058 1.016.17 1.496a18.64 18.64 0 0 1-13.532-6.86A6.536 6.536 0 0 0 1.339 7.5a6.563 6.563 0 0 0 2.921 5.465 6.54 6.54 0 0 1-2.974-.821l-.001.083a6.568 6.568 0 0 0 5.266 6.437 6.578 6.578 0 0 1-2.965.112 6.571 6.571 0 0 0 6.133 4.559 13.172 13.172 0 0 1-8.154 2.81c-.53 0-1.052-.031-1.566-.092a18.579 18.579 0 0 0 10.064 2.95c12.076 0 18.679-10.004 18.679-18.68 0-.285-.006-.568-.019-.849a13.347 13.347 0 0 0 3.276-3.398z"}))),r.createElement("a",{href:"https://github.com/10up/headstartwp","aria-hidden":"true",title:"10up on GitHub"},r.createElement("svg",{xmlns:"http://www.w3.org/2000/svg",viewBox:"0 0 32 32","aria-hidden":"true"},r.createElement("path",{d:"M16 0C7.163 0 0 7.163 0 16s7.163 16 16 16 16-7.163 16-16S24.837 0 16 0zm9.502 25.502a13.4 13.4 0 0 1-5.51 3.334v-2.398c0-1.26-.432-2.188-1.297-2.781.542-.052 1.039-.125 1.492-.219s.932-.229 1.438-.406.958-.388 1.359-.633.786-.563 1.156-.953.68-.833.93-1.328.448-1.089.594-1.781.219-1.456.219-2.289c0-1.615-.526-2.99-1.578-4.125.479-1.25.427-2.609-.156-4.078l-.391-.047c-.271-.031-.758.083-1.461.344s-1.492.688-2.367 1.281a14.367 14.367 0 0 0-3.859-.516c-1.344 0-2.625.172-3.844.516-.552-.375-1.075-.685-1.57-.93s-.891-.411-1.188-.5-.573-.143-.828-.164-.419-.026-.492-.016-.125.021-.156.031c-.583 1.479-.635 2.839-.156 4.078-1.052 1.135-1.578 2.51-1.578 4.125 0 .833.073 1.596.219 2.289s.344 1.286.594 1.781.56.938.93 1.328.755.708 1.156.953.854.456 1.359.633.984.313 1.438.406.95.167 1.492.219c-.854.583-1.281 1.51-1.281 2.781v2.445A13.4 13.4 0 0 1 6.5 25.501a13.4 13.4 0 0 1-3.936-9.502A13.4 13.4 0 0 1 6.5 6.497a13.4 13.4 0 0 1 9.502-3.936 13.4 13.4 0 0 1 9.502 3.936 13.4 13.4 0 0 1 3.936 9.502 13.4 13.4 0 0 1-3.936 9.502z"})))))))}const ot=(0,R.Qc)([U.S,_.pl,N.OC,Se.L5,i.VC,function(e){let{children:t}=e;return r.createElement(B.n2,null,r.createElement(L.M,null,r.createElement(D,null,t)))}]);function it(e){let{children:t}=e;return r.createElement(ot,null,t)}function st(e){let{error:t,tryAgain:n}=e;return r.createElement("main",{className:"container margin-vert--xl"},r.createElement("div",{className:"row"},r.createElement("div",{className:"col col--6 col--offset-3"},r.createElement("h1",{className:"hero__title"},r.createElement(l.Z,{id:"theme.ErrorPageContent.title",description:"The title of the fallback page when the page crashed"},"This page crashed.")),r.createElement("p",null,t.message),r.createElement("div",null,r.createElement("button",{type:"button",onClick:n},r.createElement(l.Z,{id:"theme.ErrorPageContent.tryAgain",description:"The label of the button to try again when the page crashed"},"Try again"))))))}const ct="mainWrapper_z2l0";function lt(e){const{children:t,noFooter:n,wrapperClassName:s,title:c,description:l}=e;return(0,b.t)(),r.createElement(it,null,r.createElement(i.d,{title:c,description:l}),r.createElement(v,null),r.createElement(O,null),r.createElement(Ue,null),r.createElement("div",{id:d,className:(0,a.Z)(g.k.wrapper.main,ct,s)},r.createElement(o.Z,{fallback:e=>r.createElement(st,e)},t)),!n&&r.createElement(at,null))}},1327:(e,t,n)=>{"use strict";n.d(t,{Z:()=>d});var r=n(7462),a=n(7294),o=n(9960),i=n(4996),s=n(2263),c=n(6668),l=n(941);function u(e){let{logo:t,alt:n,imageClassName:r}=e;const o={light:(0,i.Z)(t.src),dark:(0,i.Z)(t.srcDark||t.src)},s=a.createElement(l.Z,{className:t.className,sources:o,height:t.height,width:t.width,alt:n,style:t.style});return r?a.createElement("div",{className:r},s):s}function d(e){const{siteConfig:{title:t}}=(0,s.Z)(),{navbar:{title:n,logo:l}}=(0,c.L)(),{imageClassName:d,titleClassName:p,...f}=e,h=(0,i.Z)(l?.href||"/"),m=n?"":t,g=l?.alt??m;return a.createElement(o.Z,(0,r.Z)({to:h},f,l?.target&&{target:l.target}),l&&a.createElement(u,{logo:l,alt:g,imageClassName:d}),null!=n&&a.createElement("b",{className:p},n))}},197:(e,t,n)=>{"use strict";n.d(t,{Z:()=>o});var r=n(7294),a=n(5742);function o(e){let{locale:t,version:n,tag:o}=e;const i=t;return r.createElement(a.Z,null,t&&r.createElement("meta",{name:"docusaurus_locale",content:t}),n&&r.createElement("meta",{name:"docusaurus_version",content:n}),o&&r.createElement("meta",{name:"docusaurus_tag",content:o}),i&&r.createElement("meta",{name:"docsearch:language",content:i}),n&&r.createElement("meta",{name:"docsearch:version",content:n}),o&&r.createElement("meta",{name:"docsearch:docusaurus_tag",content:o}))}},941:(e,t,n)=>{"use strict";n.d(t,{Z:()=>l});var r=n(7462),a=n(7294),o=n(6010),i=n(2389),s=n(2949);const c={themedImage:"themedImage_ToTc","themedImage--light":"themedImage--light_HNdA","themedImage--dark":"themedImage--dark_i4oU"};function l(e){const t=(0,i.Z)(),{colorMode:n}=(0,s.I)(),{sources:l,className:u,alt:d,...p}=e,f=t?"dark"===n?["dark"]:["light"]:["light","dark"];return a.createElement(a.Fragment,null,f.map((e=>a.createElement("img",(0,r.Z)({key:e,src:l[e],alt:d,className:(0,o.Z)(c.themedImage,c[`themedImage--${e}`],u)},p)))))}},6043:(e,t,n)=>{"use strict";n.d(t,{u:()=>i,z:()=>h});var r=n(7462),a=n(7294),o=n(412);function i(e){let{initialState:t}=e;const[n,r]=(0,a.useState)(t??!1),o=(0,a.useCallback)((()=>{r((e=>!e))}),[]);return{collapsed:n,setCollapsed:r,toggleCollapsed:o}}const s={display:"none",overflow:"hidden",height:"0px"},c={display:"block",overflow:"visible",height:"auto"};function l(e,t){const n=t?s:c;e.style.display=n.display,e.style.overflow=n.overflow,e.style.height=n.height}function u(e){let{collapsibleRef:t,collapsed:n,animation:r}=e;const o=(0,a.useRef)(!1);(0,a.useEffect)((()=>{const e=t.current;function a(){const t=e.scrollHeight,n=r?.duration??function(e){const t=e/36;return Math.round(10*(4+15*t**.25+t/5))}(t);return{transition:`height ${n}ms ${r?.easing??"ease-in-out"}`,height:`${t}px`}}function i(){const t=a();e.style.transition=t.transition,e.style.height=t.height}if(!o.current)return l(e,n),void(o.current=!0);return e.style.willChange="height",function(){const t=requestAnimationFrame((()=>{n?(i(),requestAnimationFrame((()=>{e.style.height=s.height,e.style.overflow=s.overflow}))):(e.style.display="block",requestAnimationFrame((()=>{i()})))}));return()=>cancelAnimationFrame(t)}()}),[t,n,r])}function d(e){if(!o.Z.canUseDOM)return e?s:c}function p(e){let{as:t="div",collapsed:n,children:r,animation:o,onCollapseTransitionEnd:i,className:s,disableSSRStyle:c}=e;const p=(0,a.useRef)(null);return u({collapsibleRef:p,collapsed:n,animation:o}),a.createElement(t,{ref:p,style:c?void 0:d(n),onTransitionEnd:e=>{"height"===e.propertyName&&(l(p.current,n),i?.(n))},className:s},r)}function f(e){let{collapsed:t,...n}=e;const[o,i]=(0,a.useState)(!t),[s,c]=(0,a.useState)(t);return(0,a.useLayoutEffect)((()=>{t||i(!0)}),[t]),(0,a.useLayoutEffect)((()=>{o&&c(t)}),[o,t]),o?a.createElement(p,(0,r.Z)({},n,{collapsed:s})):null}function h(e){let{lazy:t,...n}=e;const r=t?f:p;return a.createElement(r,n)}},9689:(e,t,n)=>{"use strict";n.d(t,{nT:()=>h,pl:()=>f});var r=n(7294),a=n(2389),o=n(12),i=n(902),s=n(6668);const c=(0,o.WA)("docusaurus.announcement.dismiss"),l=(0,o.WA)("docusaurus.announcement.id"),u=()=>"true"===c.get(),d=e=>c.set(String(e)),p=r.createContext(null);function f(e){let{children:t}=e;const n=function(){const{announcementBar:e}=(0,s.L)(),t=(0,a.Z)(),[n,o]=(0,r.useState)((()=>!!t&&u()));(0,r.useEffect)((()=>{o(u())}),[]);const i=(0,r.useCallback)((()=>{d(!0),o(!0)}),[]);return(0,r.useEffect)((()=>{if(!e)return;const{id:t}=e;let n=l.get();"annoucement-bar"===n&&(n="announcement-bar");const r=t!==n;l.set(t),r&&d(!1),!r&&u()||o(!1)}),[e]),(0,r.useMemo)((()=>({isActive:!!e&&!n,close:i})),[e,n,i])}();return r.createElement(p.Provider,{value:n},t)}function h(){const e=(0,r.useContext)(p);if(!e)throw new i.i6("AnnouncementBarProvider");return e}},2949:(e,t,n)=>{"use strict";n.d(t,{I:()=>g,S:()=>m});var r=n(7294),a=n(412),o=n(902),i=n(12),s=n(6668);const c=r.createContext(void 0),l="theme",u=(0,i.WA)(l),d="light",p="dark",f=e=>e===p?p:d;function h(){const{colorMode:{defaultMode:e,disableSwitch:t,respectPrefersColorScheme:n}}=(0,s.L)(),[o,i]=(0,r.useState)((e=>a.Z.canUseDOM?f(document.documentElement.getAttribute("data-theme")):f(e))(e));(0,r.useEffect)((()=>{t&&u.del()}),[t]);const c=(0,r.useCallback)((function(t,r){void 0===r&&(r={});const{persist:a=!0}=r;t?(i(t),a&&(e=>{u.set(f(e))})(t)):(i(n?window.matchMedia("(prefers-color-scheme: dark)").matches?p:d:e),u.del())}),[n,e]);(0,r.useEffect)((()=>{document.documentElement.setAttribute("data-theme",f(o))}),[o]),(0,r.useEffect)((()=>{if(t)return;const e=e=>{if(e.key!==l)return;const t=u.get();null!==t&&c(f(t))};return window.addEventListener("storage",e),()=>window.removeEventListener("storage",e)}),[t,c]);const h=(0,r.useRef)(!1);return(0,r.useEffect)((()=>{if(t&&!n)return;const e=window.matchMedia("(prefers-color-scheme: dark)"),r=()=>{window.matchMedia("print").matches||h.current?h.current=window.matchMedia("print").matches:c(null)};return e.addListener(r),()=>e.removeListener(r)}),[c,t,n]),(0,r.useMemo)((()=>({colorMode:o,setColorMode:c,get isDarkTheme(){return o===p},setLightTheme(){c(d)},setDarkTheme(){c(p)}})),[o,c])}function m(e){let{children:t}=e;const n=h();return r.createElement(c.Provider,{value:n},t)}function g(){const e=(0,r.useContext)(c);if(null==e)throw new o.i6("ColorModeProvider","Please see https://docusaurus.io/docs/api/themes/configuration#use-color-mode.");return e}},373:(e,t,n)=>{"use strict";n.d(t,{J:()=>v,L5:()=>b});var r=n(7294),a=n(143),o=n(9935),i=n(6668),s=n(2802),c=n(902),l=n(12);const u=e=>`docs-preferred-version-${e}`,d=(e,t,n)=>{(0,l.WA)(u(e),{persistence:t}).set(n)},p=(e,t)=>(0,l.WA)(u(e),{persistence:t}).get(),f=(e,t)=>{(0,l.WA)(u(e),{persistence:t}).del()};const h=r.createContext(null);function m(){const e=(0,a._r)(),t=(0,i.L)().docs.versionPersistence,n=(0,r.useMemo)((()=>Object.keys(e)),[e]),[o,s]=(0,r.useState)((()=>(e=>Object.fromEntries(e.map((e=>[e,{preferredVersionName:null}]))))(n)));(0,r.useEffect)((()=>{s(function(e){let{pluginIds:t,versionPersistence:n,allDocsData:r}=e;function a(e){const t=p(e,n);return r[e].versions.some((e=>e.name===t))?{preferredVersionName:t}:(f(e,n),{preferredVersionName:null})}return Object.fromEntries(t.map((e=>[e,a(e)])))}({allDocsData:e,versionPersistence:t,pluginIds:n}))}),[e,t,n]);return[o,(0,r.useMemo)((()=>({savePreferredVersion:function(e,n){d(e,t,n),s((t=>({...t,[e]:{preferredVersionName:n}})))}})),[t])]}function g(e){let{children:t}=e;const n=m();return r.createElement(h.Provider,{value:n},t)}function b(e){let{children:t}=e;return s.cE?r.createElement(g,null,t):r.createElement(r.Fragment,null,t)}function y(){const e=(0,r.useContext)(h);if(!e)throw new c.i6("DocsPreferredVersionContextProvider");return e}function v(e){void 0===e&&(e=o.m);const t=(0,a.zh)(e),[n,i]=y(),{preferredVersionName:s}=n[e];return{preferredVersion:t.versions.find((e=>e.name===s))??null,savePreferredVersionName:(0,r.useCallback)((t=>{i.savePreferredVersion(e,t)}),[i,e])}}},1116:(e,t,n)=>{"use strict";n.d(t,{V:()=>c,b:()=>s});var r=n(7294),a=n(902);const o=Symbol("EmptyContext"),i=r.createContext(o);function s(e){let{children:t,name:n,items:a}=e;const o=(0,r.useMemo)((()=>n&&a?{name:n,items:a}:null),[n,a]);return r.createElement(i.Provider,{value:o},t)}function c(){const e=(0,r.useContext)(i);if(e===o)throw new a.i6("DocsSidebarProvider");return e}},2961:(e,t,n)=>{"use strict";n.d(t,{M:()=>p,e:()=>f});var r=n(7294),a=n(3102),o=n(7524),i=n(6550),s=(n(1688),n(902));function c(e){!function(e){const t=(0,i.k6)(),n=(0,s.zX)(e);(0,r.useEffect)((()=>t.block(((e,t)=>n(e,t)))),[t,n])}(((t,n)=>{if("POP"===n)return e(t,n)}))}var l=n(6668);const u=r.createContext(void 0);function d(){const e=function(){const e=(0,a.HY)(),{items:t}=(0,l.L)().navbar;return 0===t.length&&!e.component}(),t=(0,o.i)(),n=!e&&"mobile"===t,[i,s]=(0,r.useState)(!1);c((()=>{if(i)return s(!1),!1}));const u=(0,r.useCallback)((()=>{s((e=>!e))}),[]);return(0,r.useEffect)((()=>{"desktop"===t&&s(!1)}),[t]),(0,r.useMemo)((()=>({disabled:e,shouldRender:n,toggle:u,shown:i})),[e,n,u,i])}function p(e){let{children:t}=e;const n=d();return r.createElement(u.Provider,{value:n},t)}function f(){const e=r.useContext(u);if(void 0===e)throw new s.i6("NavbarMobileSidebarProvider");return e}},3102:(e,t,n)=>{"use strict";n.d(t,{HY:()=>s,Zo:()=>c,n2:()=>i});var r=n(7294),a=n(902);const o=r.createContext(null);function i(e){let{children:t}=e;const n=(0,r.useState)({component:null,props:null});return r.createElement(o.Provider,{value:n},t)}function s(){const e=(0,r.useContext)(o);if(!e)throw new a.i6("NavbarSecondaryMenuContentProvider");return e[0]}function c(e){let{component:t,props:n}=e;const i=(0,r.useContext)(o);if(!i)throw new a.i6("NavbarSecondaryMenuContentProvider");const[,s]=i,c=(0,a.Ql)(n);return(0,r.useEffect)((()=>{s({component:t,props:c})}),[s,t,c]),(0,r.useEffect)((()=>()=>s({component:null,props:null})),[s]),null}},9727:(e,t,n)=>{"use strict";n.d(t,{h:()=>a,t:()=>o});var r=n(7294);const a="navigation-with-keyboard";function o(){(0,r.useEffect)((()=>{function e(e){"keydown"===e.type&&"Tab"===e.key&&document.body.classList.add(a),"mousedown"===e.type&&document.body.classList.remove(a)}return document.addEventListener("keydown",e),document.addEventListener("mousedown",e),()=>{document.body.classList.remove(a),document.removeEventListener("keydown",e),document.removeEventListener("mousedown",e)}}),[])}},7524:(e,t,n)=>{"use strict";n.d(t,{i:()=>l});var r=n(7294),a=n(412);const o="desktop",i="mobile",s="ssr";function c(){return a.Z.canUseDOM?window.innerWidth>996?o:i:s}function l(){const[e,t]=(0,r.useState)((()=>c()));return(0,r.useEffect)((()=>{function e(){t(c())}return window.addEventListener("resize",e),()=>{window.removeEventListener("resize",e),clearTimeout(undefined)}}),[]),e}},5281:(e,t,n)=>{"use strict";n.d(t,{k:()=>r});const r={page:{blogListPage:"blog-list-page",blogPostPage:"blog-post-page",blogTagsListPage:"blog-tags-list-page",blogTagPostListPage:"blog-tags-post-list-page",docsDocPage:"docs-doc-page",docsTagsListPage:"docs-tags-list-page",docsTagDocListPage:"docs-tags-doc-list-page",mdxPage:"mdx-page"},wrapper:{main:"main-wrapper",blogPages:"blog-wrapper",docsPages:"docs-wrapper",mdxPages:"mdx-wrapper"},common:{editThisPage:"theme-edit-this-page",lastUpdated:"theme-last-updated",backToTopButton:"theme-back-to-top-button",codeBlock:"theme-code-block",admonition:"theme-admonition",admonitionType:e=>`theme-admonition-${e}`},layout:{},docs:{docVersionBanner:"theme-doc-version-banner",docVersionBadge:"theme-doc-version-badge",docBreadcrumbs:"theme-doc-breadcrumbs",docMarkdown:"theme-doc-markdown",docTocMobile:"theme-doc-toc-mobile",docTocDesktop:"theme-doc-toc-desktop",docFooter:"theme-doc-footer",docFooterTagsRow:"theme-doc-footer-tags-row",docFooterEditMetaRow:"theme-doc-footer-edit-meta-row",docSidebarContainer:"theme-doc-sidebar-container",docSidebarMenu:"theme-doc-sidebar-menu",docSidebarItemCategory:"theme-doc-sidebar-item-category",docSidebarItemLink:"theme-doc-sidebar-item-link",docSidebarItemCategoryLevel:e=>`theme-doc-sidebar-item-category-level-${e}`,docSidebarItemLinkLevel:e=>`theme-doc-sidebar-item-link-level-${e}`},blog:{}}},2802:(e,t,n)=>{"use strict";n.d(t,{Wl:()=>p,_F:()=>h,cE:()=>d,hI:()=>w,lO:()=>b,vY:()=>v,oz:()=>y,s1:()=>g});var r=n(7294),a=n(6550),o=n(8790),i=n(143),s=n(373),c=n(1116);function l(e){return Array.from(new Set(e))}var u=n(8596);const d=!!i._r;function p(e){if(e.href)return e.href;for(const t of e.items){if("link"===t.type)return t.href;if("category"===t.type){const e=p(t);if(e)return e}}}const f=(e,t)=>void 0!==e&&(0,u.Mg)(e,t);function h(e,t){return"link"===e.type?f(e.href,t):"category"===e.type&&(f(e.href,t)||((e,t)=>e.some((e=>h(e,t))))(e.items,t))}function m(e){let{sidebarItems:t,pathname:n,onlyCategories:r=!1}=e;const a=[];return function e(t){for(const o of t)if("category"===o.type&&((0,u.Mg)(o.href,n)||e(o.items))||"link"===o.type&&(0,u.Mg)(o.href,n)){return r&&"category"!==o.type||a.unshift(o),!0}return!1}(t),a}function g(){const e=(0,c.V)(),{pathname:t}=(0,a.TH)(),n=(0,i.gA)()?.pluginData.breadcrumbs;return!1!==n&&e?m({sidebarItems:e.items,pathname:t}):null}function b(e){const{activeVersion:t}=(0,i.Iw)(e),{preferredVersion:n}=(0,s.J)(e),a=(0,i.yW)(e);return(0,r.useMemo)((()=>l([t,n,a].filter(Boolean))),[t,n,a])}function y(e,t){const n=b(t);return(0,r.useMemo)((()=>{const t=n.flatMap((e=>e.sidebars?Object.entries(e.sidebars):[])),r=t.find((t=>t[0]===e));if(!r)throw new Error(`Can't find any sidebar with id "${e}" in version${n.length>1?"s":""} ${n.map((e=>e.name)).join(", ")}".\n Available sidebar ids are:\n - ${Object.keys(t).join("\n- ")}`);return r[1]}),[e,n])}function v(e,t){const n=b(t);return(0,r.useMemo)((()=>{const t=n.flatMap((e=>e.docs)),r=t.find((t=>t.id===e));if(!r){if(n.flatMap((e=>e.draftIds)).includes(e))return null;throw new Error(`DocNavbarItem: couldn't find any doc with id "${e}" in version${n.length>1?"s":""} ${n.map((e=>e.name)).join(", ")}".\nAvailable doc ids are:\n- ${l(t.map((e=>e.id))).join("\n- ")}`)}return r}),[e,n])}function w(e){let{route:t,versionMetadata:n}=e;const r=(0,a.TH)(),i=t.routes,s=i.find((e=>(0,a.LX)(r.pathname,e)));if(!s)return null;const c=s.sidebar,l=c?n.docsSidebars[c]:void 0;return{docElement:(0,o.H)(i),sidebarName:c,sidebarItems:l}}},1944:(e,t,n)=>{"use strict";n.d(t,{FG:()=>p,d:()=>u,VC:()=>f});var r=n(7294),a=n(6010),o=n(5742),i=n(226);function s(){const e=r.useContext(i._);if(!e)throw new Error("Unexpected: no Docusaurus route context found");return e}var c=n(4996),l=n(2263);function u(e){let{title:t,description:n,keywords:a,image:i,children:s}=e;const u=function(e){const{siteConfig:t}=(0,l.Z)(),{title:n,titleDelimiter:r}=t;return e?.trim().length?`${e.trim()} ${r} ${n}`:n}(t),{withBaseUrl:d}=(0,c.C)(),p=i?d(i,{absolute:!0}):void 0;return r.createElement(o.Z,null,t&&r.createElement("title",null,u),t&&r.createElement("meta",{property:"og:title",content:u}),n&&r.createElement("meta",{name:"description",content:n}),n&&r.createElement("meta",{property:"og:description",content:n}),a&&r.createElement("meta",{name:"keywords",content:Array.isArray(a)?a.join(","):a}),p&&r.createElement("meta",{property:"og:image",content:p}),p&&r.createElement("meta",{name:"twitter:image",content:p}),s)}const d=r.createContext(void 0);function p(e){let{className:t,children:n}=e;const i=r.useContext(d),s=(0,a.Z)(i,t);return r.createElement(d.Provider,{value:s},r.createElement(o.Z,null,r.createElement("html",{className:s})),n)}function f(e){let{children:t}=e;const n=s(),o=`plugin-${n.plugin.name.replace(/docusaurus-(?:plugin|theme)-(?:content-)?/gi,"")}`;const i=`plugin-id-${n.plugin.id}`;return r.createElement(p,{className:(0,a.Z)(o,i)},t)}},902:(e,t,n)=>{"use strict";n.d(t,{D9:()=>i,Qc:()=>l,Ql:()=>c,i6:()=>s,zX:()=>o});var r=n(7294);const a=n(412).Z.canUseDOM?r.useLayoutEffect:r.useEffect;function o(e){const t=(0,r.useRef)(e);return a((()=>{t.current=e}),[e]),(0,r.useCallback)((function(){return t.current(...arguments)}),[])}function i(e){const t=(0,r.useRef)();return a((()=>{t.current=e})),t.current}class s extends Error{constructor(e,t){super(),this.name="ReactContextError",this.message=`Hook ${this.stack?.split("\n")[1]?.match(/at (?:\w+\.)?(?\w+)/)?.groups.name??""} is called outside the <${e}>. ${t??""}`}}function c(e){const t=Object.entries(e);return t.sort(((e,t)=>e[0].localeCompare(t[0]))),(0,r.useMemo)((()=>e),t.flat())}function l(e){return t=>{let{children:n}=t;return r.createElement(r.Fragment,null,e.reduceRight(((e,t)=>r.createElement(t,null,e)),n))}}},8596:(e,t,n)=>{"use strict";n.d(t,{Mg:()=>i,Ns:()=>s});var r=n(7294),a=n(723),o=n(2263);function i(e,t){const n=e=>(!e||e.endsWith("/")?e:`${e}/`)?.toLowerCase();return n(e)===n(t)}function s(){const{baseUrl:e}=(0,o.Z)().siteConfig;return(0,r.useMemo)((()=>function(e){let{baseUrl:t,routes:n}=e;function r(e){return e.path===t&&!0===e.exact}function a(e){return e.path===t&&!e.exact}return function e(t){if(0===t.length)return;return t.find(r)||e(t.filter(a).flatMap((e=>e.routes??[])))}(n)}({routes:a.Z,baseUrl:e})),[e])}},2466:(e,t,n)=>{"use strict";n.d(t,{Ct:()=>p,OC:()=>c,RF:()=>d});var r=n(7294),a=n(412),o=n(2389),i=n(902);const s=r.createContext(void 0);function c(e){let{children:t}=e;const n=function(){const e=(0,r.useRef)(!0);return(0,r.useMemo)((()=>({scrollEventsEnabledRef:e,enableScrollEvents:()=>{e.current=!0},disableScrollEvents:()=>{e.current=!1}})),[])}();return r.createElement(s.Provider,{value:n},t)}function l(){const e=(0,r.useContext)(s);if(null==e)throw new i.i6("ScrollControllerProvider");return e}const u=()=>a.Z.canUseDOM?{scrollX:window.pageXOffset,scrollY:window.pageYOffset}:null;function d(e,t){void 0===t&&(t=[]);const{scrollEventsEnabledRef:n}=l(),a=(0,r.useRef)(u()),o=(0,i.zX)(e);(0,r.useEffect)((()=>{const e=()=>{if(!n.current)return;const e=u();o(e,a.current),a.current=e},t={passive:!0};return e(),window.addEventListener("scroll",e,t),()=>window.removeEventListener("scroll",e,t)}),[o,n,...t])}function p(){const e=(0,r.useRef)(null),t=(0,o.Z)()&&"smooth"===getComputedStyle(document.documentElement).scrollBehavior;return{startScroll:n=>{e.current=t?function(e){return window.scrollTo({top:e,behavior:"smooth"}),()=>{}}(n):function(e){let t=null;const n=document.documentElement.scrollTop>e;return function r(){const a=document.documentElement.scrollTop;(n&&a>e||!n&&at&&cancelAnimationFrame(t)}(n)},cancelScroll:()=>e.current?.()}}},3320:(e,t,n)=>{"use strict";n.d(t,{HX:()=>r,os:()=>a});n(2263);const r="default";function a(e,t){return`docs-${e}-${t}`}},12:(e,t,n)=>{"use strict";n.d(t,{WA:()=>c});n(7294),n(1688);const r="localStorage";function a(e){let{key:t,oldValue:n,newValue:r,storage:a}=e;if(n===r)return;const o=document.createEvent("StorageEvent");o.initStorageEvent("storage",!1,!1,t,n,r,window.location.href,a),window.dispatchEvent(o)}function o(e){if(void 0===e&&(e=r),"undefined"==typeof window)throw new Error("Browser storage is not available on Node.js/Docusaurus SSR process.");if("none"===e)return null;try{return window[e]}catch(n){return t=n,i||(console.warn("Docusaurus browser storage is not available.\nPossible reasons: running Docusaurus in an iframe, in an incognito browser session, or using too strict browser privacy settings.",t),i=!0),null}var t}let i=!1;const s={get:()=>null,set:()=>{},del:()=>{},listen:()=>()=>{}};function c(e,t){if("undefined"==typeof window)return function(e){function t(){throw new Error(`Illegal storage API usage for storage key "${e}".\nDocusaurus storage APIs are not supposed to be called on the server-rendering process.\nPlease only call storage APIs in effects and event handlers.`)}return{get:t,set:t,del:t,listen:t}}(e);const n=o(t?.persistence);return null===n?s:{get:()=>{try{return n.getItem(e)}catch(t){return console.error(`Docusaurus storage error, can't get key=${e}`,t),null}},set:t=>{try{const r=n.getItem(e);n.setItem(e,t),a({key:e,oldValue:r,newValue:t,storage:n})}catch(r){console.error(`Docusaurus storage error, can't set ${e}=${t}`,r)}},del:()=>{try{const t=n.getItem(e);n.removeItem(e),a({key:e,oldValue:t,newValue:null,storage:n})}catch(t){console.error(`Docusaurus storage error, can't delete key=${e}`,t)}},listen:t=>{try{const r=r=>{r.storageArea===n&&r.key===e&&t(r)};return window.addEventListener("storage",r),()=>window.removeEventListener("storage",r)}catch(r){return console.error(`Docusaurus storage error, can't listen for changes of key=${e}`,r),()=>{}}}}}},4711:(e,t,n)=>{"use strict";n.d(t,{l:()=>o});var r=n(2263),a=n(6550);function o(){const{siteConfig:{baseUrl:e,url:t},i18n:{defaultLocale:n,currentLocale:o}}=(0,r.Z)(),{pathname:i}=(0,a.TH)(),s=o===n?e:e.replace(`/${o}/`,"/"),c=i.replace(e,"");return{createUrl:function(e){let{locale:r,fullyQualified:a}=e;return`${a?t:""}${function(e){return e===n?`${s}`:`${s}${e}/`}(r)}${c}`}}}},5936:(e,t,n)=>{"use strict";n.d(t,{S:()=>i});var r=n(7294),a=n(6550),o=n(902);function i(e){const t=(0,a.TH)(),n=(0,o.D9)(t),i=(0,o.zX)(e);(0,r.useEffect)((()=>{n&&t!==n&&i({location:t,previousLocation:n})}),[i,t,n])}},6668:(e,t,n)=>{"use strict";n.d(t,{L:()=>a});var r=n(2263);function a(){return(0,r.Z)().siteConfig.themeConfig}},8802:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.default=function(e,t){const{trailingSlash:n,baseUrl:r}=t;if(e.startsWith("#"))return e;if(void 0===n)return e;const[a]=e.split(/[#?]/),o="/"===a||a===r?a:(i=a,n?function(e){return e.endsWith("/")?e:`${e}/`}(i):function(e){return e.endsWith("/")?e.slice(0,-1):e}(i));var i;return e.replace(a,o)}},8780:function(e,t,n){"use strict";var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0}),t.applyTrailingSlash=t.blogPostContainerID=void 0,t.blogPostContainerID="post-content";var a=n(8802);Object.defineProperty(t,"applyTrailingSlash",{enumerable:!0,get:function(){return r(a).default}})},311:(e,t,n)=>{"use strict";n.d(t,{Z:()=>i});var r=n(7294),a=n(6010);const o="loadingRing_RJI3";function i(e){let{className:t}=e;return r.createElement("div",{className:(0,a.Z)(o,t)},r.createElement("div",null),r.createElement("div",null),r.createElement("div",null),r.createElement("div",null))}},22:(e,t,n)=>{"use strict";n.d(t,{w:()=>s});var r=n(1336),a=n.n(r),o=n(1029);const i=new Map;function s(e,t){const n=`${e}${t}`;let r=i.get(n);return r||(r=async function(e,t){{const n=`${e}${o.J.replace("{dir}",t?`-${t.replace(/\//g,"-")}`:"")}`;if(new URL(n,location.origin).origin!==location.origin)throw new Error("Unexpected version url");const r=await(await fetch(n)).json(),i=r.map(((e,t)=>{let{documents:n,index:r}=e;return{type:t,documents:n,index:a().Index.load(r)}})),s=r.reduce(((e,t)=>{for(const n of t.index.invertedIndex)/\p{Unified_Ideograph}/u.test(n[0][0])&&e.add(n[0]);return e}),new Set);return{wrappedIndexes:i,zhDictionary:Array.from(s)}}return{wrappedIndexes:[],zhDictionary:[]}}(e,t),i.set(n,r)),r}},7445:(e,t,n)=>{"use strict";n.d(t,{Z:()=>Y});var r=n(1029),a=n(7294),o=n(6010),i=n(2263),s=n(412),c=n(6550),l=n(5999),u=n(373),d=n(902),p=n(143),f=n(22),h=n(8202),m=n(3926),g=n(1073),b=n(2539),y=n(726);const v="searchBar_RVTs",w="dropdownMenu_qbY6",_="searchBarLeft_MXDe",k="suggestion_fB_2",S="cursor_eG29",E="hitTree_kk6K",x="hitIcon_a7Zy",P="hitPath_ieM4",T="noResultsIcon_EBY5",C="hitFooter_E9YW",I="hitWrapper_sAK8",A="hitTitle_vyVt",O="hitAction_NqkB",L="noResults_l6Q3",N="searchBarContainer_NW3z",R="searchBarLoadingRing_YnHq",B="searchClearButton_qk4g",F="searchIndexLoading_EJ1f",D="searchHintContainer_Pkmr",M="searchHint_iIMx",$="focused_OWtg",z="input_FOTf",U="hint_URu1",j="suggestions_X8XU",H="dataset_QiCy",G="empty_eITn";function Z(e){let{document:t,type:n,page:a,metadata:o,tokens:i,isInterOfTree:s,isLastOfTree:c}=e;const l=0===n,u=1===n,d=[];s?d.push(''):c&&d.push('');const p=d.map((e=>`${e}`)),f=`${l?'':u?'':''}`,h=[`${(0,y.o)(t.t,(0,g.m)(o,"t"),i)}`];if(!s&&!c&&r.H6){const e=a?(a.b??[]).concat(a.t).concat(t.s&&t.s!==a.t?t.s:[]):t.b;h.push(`${(0,m.e)(e??[])}`)}else l||h.push(`${(0,b.C)(a.t||(t.u.startsWith("/docs/api-reference/")?"API Reference":""),i)}`);const v=``;return[...p,f,``,...h,"",v].join("")}function Q(){return`${(0,l.I)({id:"theme.SearchBar.noResultsText",message:"No results"})}`}var V=n(311);async function W(){const e=await Promise.all([n.e(8443),n.e(5525)]).then(n.t.bind(n,8443,23)),t=e.default;return t.noConflict?t.noConflict():e.noConflict&&e.noConflict(),t}const q="_highlight";const Y=function(e){let{handleSearchBarToggle:t}=e;const{siteConfig:{baseUrl:n}}=(0,i.Z)(),m=(0,p.gA)();let g=n;try{const{preferredVersion:e}=(0,u.J)(m?.pluginId??r.gQ);e&&!e.isLast&&(g=e.path+"/")}catch(de){if(r.l9&&!(de instanceof d.i6))throw de}const b=(0,c.k6)(),y=(0,c.TH)(),E=(0,a.useRef)(null),x=(0,a.useRef)(new Map),P=(0,a.useRef)(!1),[T,I]=(0,a.useState)(!1),[A,O]=(0,a.useState)(!1),[L,Y]=(0,a.useState)(""),K=(0,a.useRef)(null),X=(0,a.useRef)(""),[J,ee]=(0,a.useState)("");(0,a.useEffect)((()=>{if(!Array.isArray(r.Kc))return;let e="";if(y.pathname.startsWith(g)){const t=y.pathname.substring(g.length),n=r.Kc.find((e=>t===e||t.startsWith(`${e}/`)));n&&(e=n)}X.current!==e&&(x.current.delete(e),X.current=e),ee(e)}),[y.pathname,g]);const te=!!r.hG&&Array.isArray(r.Kc)&&""===J,ne=(0,a.useCallback)((async()=>{if(te||x.current.get(J))return;x.current.set(J,"loading"),K.current?.autocomplete.destroy(),I(!0);const[{wrappedIndexes:e,zhDictionary:t},a]=await Promise.all([(0,f.w)(g,J),W()]);if(K.current=a(E.current,{hint:!1,autoselect:!0,openOnFocus:!0,cssClasses:{root:(0,o.Z)(v,{[_]:"left"===r.pu}),noPrefix:!0,dropdownMenu:w,input:z,hint:U,suggestions:j,suggestion:k,cursor:S,dataset:H,empty:G}},[{source:(0,h.v)(e,t,r.qo),templates:{suggestion:Z,empty:Q,footer:e=>{let{query:t,isEmpty:a}=e;if(a)return;const o=document.createElement("a"),i=new URLSearchParams;if(i.set("q",t),Array.isArray(r.Kc)&&i.set("ctx",J),g!==n){if(!g.startsWith(n))throw new Error(`Version url '${g}' does not start with base url '${n}', this is a bug of \`@easyops-cn/docusaurus-search-local\`, please report it.`);i.set("version",g.substring(n.length))}const s=`${n}search?${i.toString()}`;o.href=s,o.textContent=(0,l.I)({id:"theme.SearchBar.seeAll",message:"See all results"}),o.addEventListener("click",(e=>{e.ctrlKey||e.metaKey||(e.preventDefault(),K.current?.autocomplete.close(),b.push(s))}));const c=document.createElement("div");return c.className=C,c.appendChild(o),c}}}]).on("autocomplete:selected",(function(e,t){let{document:{u:n,h:a},tokens:o}=t;E.current?.blur();let i=n;if(r.vc&&o.length>0){const e=new URLSearchParams;for(const t of o)e.append(q,t);i+=`?${e.toString()}`}a&&(i+=a),b.push(i)})).on("autocomplete:closed",(()=>{E.current?.blur()})),x.current.set(J,"done"),I(!1),P.current){const e=E.current;e.value&&K.current?.autocomplete.open(),e.focus()}}),[te,J,g,n,b]);(0,a.useEffect)((()=>{if(!r.vc)return;const e=s.Z.canUseDOM?new URLSearchParams(y.search).getAll(q):[];setTimeout((()=>{const t=document.querySelector("article");if(!t)return;const n=new r.vc(t);n.unmark(),0!==e.length&&n.mark(e),Y(e.join(" ")),K.current?.autocomplete.setVal(e.join(" "))}))}),[y.search,y.pathname]);const[re,ae]=(0,a.useState)(!1),oe=(0,a.useCallback)((()=>{P.current=!0,ne(),ae(!0),t?.(!0)}),[t,ne]),ie=(0,a.useCallback)((()=>{ae(!1),t?.(!1)}),[t]),se=(0,a.useCallback)((()=>{ne()}),[ne]),ce=(0,a.useCallback)((e=>{Y(e.target.value),e.target.value&&O(!0)}),[]),le=!!s.Z.canUseDOM&&/mac/i.test(navigator.userAgentData?.platform??navigator.platform);(0,a.useEffect)((()=>{if(!r.AY)return;const e=e=>{!(le?e.metaKey:e.ctrlKey)||"k"!==e.key&&"K"!==e.key||(e.preventDefault(),E.current?.focus(),oe())};return document.addEventListener("keydown",e),()=>{document.removeEventListener("keydown",e)}}),[le,oe]);const ue=(0,a.useCallback)((()=>{const e=new URLSearchParams(y.search);e.delete(q);const t=e.toString(),n=y.pathname+(""!=t?`?${t}`:"")+y.hash;n!=y.pathname+y.search+y.hash&&b.push(n),Y(""),K.current?.autocomplete.setVal("")}),[y.pathname,y.search,y.hash,b]);return a.createElement("div",{className:(0,o.Z)("navbar__search",N,{[F]:T&&A,[$]:re}),hidden:te},a.createElement("input",{placeholder:(0,l.I)({id:"theme.SearchBar.label",message:"Search",description:"The ARIA label and placeholder for search button"}),"aria-label":"Search",className:"navbar__search-input",onMouseEnter:se,onFocus:oe,onBlur:ie,onChange:ce,ref:E,value:L}),a.createElement(V.Z,{className:R}),r.AY&&r.t_&&(""!==L?a.createElement("button",{className:B,onClick:ue},"\u2715"):s.Z.canUseDOM&&a.createElement("div",{className:D},a.createElement("kbd",{className:M},le?"\u2318":"ctrl"),a.createElement("kbd",{className:M},"K"))))}},8202:(e,t,n)=>{"use strict";n.d(t,{v:()=>c});var r=n(1336),a=n.n(r);var o=n(1029);function i(e){return s(e).concat(s(e.filter((e=>{const t=e[e.length-1];return!t.trailing&&t.maybeTyping})),!0))}function s(e,t){return e.map((e=>({tokens:e.map((e=>e.value)),term:e.map((e=>({value:e.value,presence:a().Query.presence.REQUIRED,wildcard:(t?e.trailing||e.maybeTyping:e.trailing)?a().Query.wildcard.TRAILING:a().Query.wildcard.NONE})))})))}function c(e,t,n){return function(r,s){const c=function(e,t){if(1===t.length&&["ja","jp","th"].includes(t[0]))return a()[t[0]].tokenizer(e).map((e=>e.toString()));let n=/[^-\s]+/g;return t.includes("zh")&&(n=/\w+|\p{Unified_Ideograph}+/gu),e.toLowerCase().match(n)||[]}(r,o.dK);if(0===c.length)return void s([]);const l=function(e,t){const n=function(e,t){const n=[];return function e(r,a){if(0===r.length)return void n.push(a);const o=r[0];if(/\p{Unified_Ideograph}/u.test(o)){const n=function(e,t){const n=[];return function e(r,a){let o=0,i=!1;for(const s of t)if(r.substr(0,s.length)===s){const t={missed:a.missed,term:a.term.concat({value:s})};r.length>s.length?e(r.substr(s.length),t):n.push(t),i=!0}else for(let t=s.length-1;t>o;t-=1){const c=s.substr(0,t);if(r.substr(0,t)===c){o=t;const s={missed:a.missed,term:a.term.concat({value:c,trailing:!0})};r.length>t?e(r.substr(t),s):n.push(s),i=!0;break}}i||(r.length>0?e(r.substr(1),{missed:a.missed+1,term:a.term}):a.term.length>0&&n.push(a))}(e,{missed:0,term:[]}),n.sort(((e,t)=>{const n=e.missed>0?1:0,r=t.missed>0?1:0;return n!==r?n-r:e.term.length-t.term.length})).map((e=>e.term))}(o,t);for(const t of n){const n=a.concat(...t);e(r.slice(1),n)}}else{const t=a.concat({value:o});e(r.slice(1),t)}}(e,[]),n}(e,t);if(0===n.length)return[{tokens:e,term:e.map((e=>({value:e,presence:a().Query.presence.REQUIRED,wildcard:a().Query.wildcard.LEADING|a().Query.wildcard.TRAILING})))}];for(const a of n)a[a.length-1].maybeTyping=!0;const r=[];for(const i of o.dK)if("en"===i)o._k||r.unshift(a().stopWordFilter);else{const e=a()[i];e.stopWordFilter&&r.unshift(e.stopWordFilter)}let s;if(r.length>0){const e=e=>r.reduce(((e,t)=>e.filter((e=>t(e.value)))),e);s=[];const t=[];for(const r of n){const n=e(r);s.push(n),n.length0&&t.push(n)}n.push(...t)}else s=n.slice();const c=[];for(const a of s)if(a.length>2)for(let e=a.length-1;e>=0;e-=1)c.push(a.slice(0,e).concat(a.slice(e+1)));return i(n).concat(i(c))}(c,t),u=[];e:for(const{term:t,tokens:a}of l)for(const{documents:r,index:o,type:i}of e)if(u.push(...o.query((e=>{for(const n of t)e.term(n.value,{wildcard:n.wildcard,presence:n.presence})})).slice(0,n).filter((e=>!u.some((t=>t.document.i.toString()===e.ref)))).slice(0,n-u.length).map((t=>{const n=r.find((e=>e.i.toString()===t.ref));return{document:n,type:i,page:0!==i&&e[0].documents.find((e=>e.i===n.p)),metadata:t.matchData.metadata,tokens:a,score:t.score}}))),u.length>=n)break e;!function(e){e.forEach(((e,t)=>{e.index=t})),e.sort(((t,n)=>{let r=t.type>0&&t.page?e.findIndex((e=>e.document===t.page)):t.index,a=n.type>0&&n.page?e.findIndex((e=>e.document===n.page)):n.index;return-1===r&&(r=t.index),-1===a&&(a=n.index),r===a?0===t.type?-1:0===n.type?1:t.index-n.index:r-a}))}(u),function(e){e.forEach(((t,n)=>{n>0&&t.page&&e.some((e=>e.document===t.page))&&(n{"use strict";function r(e){return e.join(" \u203a ")}n.d(t,{e:()=>r})},1690:(e,t,n)=>{"use strict";function r(e){return e.replace(/&/g,"&").replace(//g,">").replace(/"/g,""").replace(/'/g,"'")}n.d(t,{X:()=>r})},1073:(e,t,n)=>{"use strict";function r(e,t){const n=[];for(const r of Object.values(e))r[t]&&n.push(...r[t].position);return n.sort(((e,t)=>e[0]-t[0]||t[1]-e[1]))}n.d(t,{m:()=>r})},2539:(e,t,n)=>{"use strict";n.d(t,{C:()=>a});var r=n(1690);function a(e,t,n){const o=[];for(const i of t){const n=e.toLowerCase().indexOf(i);if(n>=0){n>0&&o.push(a(e.substr(0,n),t)),o.push(`${(0,r.X)(e.substr(n,i.length))}`);const s=n+i.length;s${(0,r.X)(e)}`:(0,r.X)(e):o.join("")}},726:(e,t,n)=>{"use strict";n.d(t,{o:()=>c});var r=n(1690),a=n(2539);const o=/\w+|\p{Unified_Ideograph}/u;function i(e){const t=[];let n=0,r=e;for(;r.length>0;){const a=r.match(o);if(!a){t.push(r);break}a.index>0&&t.push(r.substring(0,a.index)),t.push(a[0]),n+=a.index+a[0].length,r=e.substring(n)}return t}var s=n(1029);function c(e,t,n,o){void 0===o&&(o=s.Hk);const{chunkIndex:c,chunks:l}=function(e,t,n){const o=[];let s=0,c=0,l=-1;for(;sc){const t=i(e.substring(c,u)).map((e=>({html:(0,r.X)(e),textLength:e.length})));for(const e of t)o.push(e)}-1===l&&(l=o.length),c=u+d,o.push({html:(0,a.C)(e.substring(u,c),n,!0),textLength:d})}}if(c({html:(0,r.X)(e),textLength:e.length})));for(const e of t)o.push(e)}return{chunkIndex:l,chunks:o}}(e,t,n),u=l.slice(0,c),d=l[c],p=[d.html],f=l.slice(c+1);let h=d.textLength,m=0,g=0,b=!1,y=!1;for(;h0){const e=u.pop();h+e.textLength<=o?(p.unshift(e.html),m+=e.textLength,h+=e.textLength):(b=!0,u.length=0)}else{if(!(f.length>0))break;{const e=f.shift();h+e.textLength<=o?(p.push(e.html),g+=e.textLength,h+=e.textLength):(y=!0,f.length=0)}}return(b||u.length>0)&&p.unshift("\u2026"),(y||f.length>0)&&p.push("\u2026"),p.join("")}},1029:(e,t,n)=>{"use strict";n.d(t,{vc:()=>o,gQ:()=>f,H6:()=>l,hG:()=>g,l9:()=>h,dK:()=>r,_k:()=>a,pu:()=>p,AY:()=>u,t_:()=>d,Kc:()=>m,J:()=>i,Hk:()=>c,qo:()=>s});n(1336);const r=["en"],a=!1,o=null,i="search-index{dir}.json?_=b3fad9da",s=8,c=50,l=!1,u=!0,d=!0,p="right",f=void 0,h=!0,m=null,g=!1},6010:(e,t,n)=>{"use strict";function r(e){var t,n,a="";if("string"==typeof e||"number"==typeof e)a+=e;else if("object"==typeof e)if(Array.isArray(e))for(t=0;ta});const a=function(){for(var e,t,n=0,a="";n{"use strict";n.d(t,{lX:()=>w,q_:()=>P,ob:()=>f,PP:()=>C,Ep:()=>p});var r=n(7462);function a(e){return"/"===e.charAt(0)}function o(e,t){for(var n=t,r=n+1,a=e.length;r=0;p--){var f=i[p];"."===f?o(i,p):".."===f?(o(i,p),d++):d&&(o(i,p),d--)}if(!l)for(;d--;d)i.unshift("..");!l||""===i[0]||i[0]&&a(i[0])||i.unshift("");var h=i.join("/");return n&&"/"!==h.substr(-1)&&(h+="/"),h};var s=n(8776);function c(e){return"/"===e.charAt(0)?e:"/"+e}function l(e){return"/"===e.charAt(0)?e.substr(1):e}function u(e,t){return function(e,t){return 0===e.toLowerCase().indexOf(t.toLowerCase())&&-1!=="/?#".indexOf(e.charAt(t.length))}(e,t)?e.substr(t.length):e}function d(e){return"/"===e.charAt(e.length-1)?e.slice(0,-1):e}function p(e){var t=e.pathname,n=e.search,r=e.hash,a=t||"/";return n&&"?"!==n&&(a+="?"===n.charAt(0)?n:"?"+n),r&&"#"!==r&&(a+="#"===r.charAt(0)?r:"#"+r),a}function f(e,t,n,a){var o;"string"==typeof e?(o=function(e){var t=e||"/",n="",r="",a=t.indexOf("#");-1!==a&&(r=t.substr(a),t=t.substr(0,a));var o=t.indexOf("?");return-1!==o&&(n=t.substr(o),t=t.substr(0,o)),{pathname:t,search:"?"===n?"":n,hash:"#"===r?"":r}}(e),o.state=t):(void 0===(o=(0,r.Z)({},e)).pathname&&(o.pathname=""),o.search?"?"!==o.search.charAt(0)&&(o.search="?"+o.search):o.search="",o.hash?"#"!==o.hash.charAt(0)&&(o.hash="#"+o.hash):o.hash="",void 0!==t&&void 0===o.state&&(o.state=t));try{o.pathname=decodeURI(o.pathname)}catch(s){throw s instanceof URIError?new URIError('Pathname "'+o.pathname+'" could not be decoded. This is likely caused by an invalid percent-encoding.'):s}return n&&(o.key=n),a?o.pathname?"/"!==o.pathname.charAt(0)&&(o.pathname=i(o.pathname,a.pathname)):o.pathname=a.pathname:o.pathname||(o.pathname="/"),o}function h(){var e=null;var t=[];return{setPrompt:function(t){return e=t,function(){e===t&&(e=null)}},confirmTransitionTo:function(t,n,r,a){if(null!=e){var o="function"==typeof e?e(t,n):e;"string"==typeof o?"function"==typeof r?r(o,a):a(!0):a(!1!==o)}else a(!0)},appendListener:function(e){var n=!0;function r(){n&&e.apply(void 0,arguments)}return t.push(r),function(){n=!1,t=t.filter((function(e){return e!==r}))}},notifyListeners:function(){for(var e=arguments.length,n=new Array(e),r=0;rt?n.splice(t,n.length-t,a):n.push(a),d({action:r,location:a,index:t,entries:n})}}))},replace:function(e,t){var r="REPLACE",a=f(e,t,m(),w.location);u.confirmTransitionTo(a,r,n,(function(e){e&&(w.entries[w.index]=a,d({action:r,location:a}))}))},go:v,goBack:function(){v(-1)},goForward:function(){v(1)},canGo:function(e){var t=w.index+e;return t>=0&&t{"use strict";var r=n(9864),a={childContextTypes:!0,contextType:!0,contextTypes:!0,defaultProps:!0,displayName:!0,getDefaultProps:!0,getDerivedStateFromError:!0,getDerivedStateFromProps:!0,mixins:!0,propTypes:!0,type:!0},o={name:!0,length:!0,prototype:!0,caller:!0,callee:!0,arguments:!0,arity:!0},i={$$typeof:!0,compare:!0,defaultProps:!0,displayName:!0,propTypes:!0,type:!0},s={};function c(e){return r.isMemo(e)?i:s[e.$$typeof]||a}s[r.ForwardRef]={$$typeof:!0,render:!0,defaultProps:!0,displayName:!0,propTypes:!0},s[r.Memo]=i;var l=Object.defineProperty,u=Object.getOwnPropertyNames,d=Object.getOwnPropertySymbols,p=Object.getOwnPropertyDescriptor,f=Object.getPrototypeOf,h=Object.prototype;e.exports=function e(t,n,r){if("string"!=typeof n){if(h){var a=f(n);a&&a!==h&&e(t,a,r)}var i=u(n);d&&(i=i.concat(d(n)));for(var s=c(t),m=c(n),g=0;g{"use strict";e.exports=function(e,t,n,r,a,o,i,s){if(!e){var c;if(void 0===t)c=new Error("Minified exception occurred; use the non-minified dev environment for the full error message and additional helpful warnings.");else{var l=[n,r,a,o,i,s],u=0;(c=new Error(t.replace(/%s/g,(function(){return l[u++]})))).name="Invariant Violation"}throw c.framesToPop=1,c}}},5826:e=>{e.exports=Array.isArray||function(e){return"[object Array]"==Object.prototype.toString.call(e)}},1336:(e,t,n)=>{var r,a;!function(){var o,i,s,c,l,u,d,p,f,h,m,g,b,y,v,w,_,k,S,E,x,P,T,C,I,A,O,L,N,R,B=function(e){var t=new B.Builder;return t.pipeline.add(B.trimmer,B.stopWordFilter,B.stemmer),t.searchPipeline.add(B.stemmer),e.call(t,t),t.build()};B.version="2.3.9",B.utils={},B.utils.warn=(o=this,function(e){o.console&&console.warn&&console.warn(e)}),B.utils.asString=function(e){return null==e?"":e.toString()},B.utils.clone=function(e){if(null==e)return e;for(var t=Object.create(null),n=Object.keys(e),r=0;r0){var c=B.utils.clone(t)||{};c.position=[i,s],c.index=a.length,a.push(new B.Token(n.slice(i,o),c))}i=o+1}}return a},B.tokenizer.separator=/[\s\-]+/,B.Pipeline=function(){this._stack=[]},B.Pipeline.registeredFunctions=Object.create(null),B.Pipeline.registerFunction=function(e,t){t in this.registeredFunctions&&B.utils.warn("Overwriting existing registered function: "+t),e.label=t,B.Pipeline.registeredFunctions[e.label]=e},B.Pipeline.warnIfFunctionNotRegistered=function(e){e.label&&e.label in this.registeredFunctions||B.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},B.Pipeline.load=function(e){var t=new B.Pipeline;return e.forEach((function(e){var n=B.Pipeline.registeredFunctions[e];if(!n)throw new Error("Cannot load unregistered function: "+e);t.add(n)})),t},B.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach((function(e){B.Pipeline.warnIfFunctionNotRegistered(e),this._stack.push(e)}),this)},B.Pipeline.prototype.after=function(e,t){B.Pipeline.warnIfFunctionNotRegistered(t);var n=this._stack.indexOf(e);if(-1==n)throw new Error("Cannot find existingFn");n+=1,this._stack.splice(n,0,t)},B.Pipeline.prototype.before=function(e,t){B.Pipeline.warnIfFunctionNotRegistered(t);var n=this._stack.indexOf(e);if(-1==n)throw new Error("Cannot find existingFn");this._stack.splice(n,0,t)},B.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);-1!=t&&this._stack.splice(t,1)},B.Pipeline.prototype.run=function(e){for(var t=this._stack.length,n=0;n1&&(oe&&(n=a),o!=e);)r=n-t,a=t+Math.floor(r/2),o=this.elements[2*a];return o==e||o>e?2*a:os?l+=2:i==s&&(t+=n[c+1]*r[l+1],c+=2,l+=2);return t},B.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},B.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,n=0;t0){var o,i=a.str.charAt(0);i in a.node.edges?o=a.node.edges[i]:(o=new B.TokenSet,a.node.edges[i]=o),1==a.str.length&&(o.final=!0),r.push({node:o,editsRemaining:a.editsRemaining,str:a.str.slice(1)})}if(0!=a.editsRemaining){if("*"in a.node.edges)var s=a.node.edges["*"];else{s=new B.TokenSet;a.node.edges["*"]=s}if(0==a.str.length&&(s.final=!0),r.push({node:s,editsRemaining:a.editsRemaining-1,str:a.str}),a.str.length>1&&r.push({node:a.node,editsRemaining:a.editsRemaining-1,str:a.str.slice(1)}),1==a.str.length&&(a.node.final=!0),a.str.length>=1){if("*"in a.node.edges)var c=a.node.edges["*"];else{c=new B.TokenSet;a.node.edges["*"]=c}1==a.str.length&&(c.final=!0),r.push({node:c,editsRemaining:a.editsRemaining-1,str:a.str.slice(1)})}if(a.str.length>1){var l,u=a.str.charAt(0),d=a.str.charAt(1);d in a.node.edges?l=a.node.edges[d]:(l=new B.TokenSet,a.node.edges[d]=l),1==a.str.length&&(l.final=!0),r.push({node:l,editsRemaining:a.editsRemaining-1,str:u+a.str.slice(2)})}}}return n},B.TokenSet.fromString=function(e){for(var t=new B.TokenSet,n=t,r=0,a=e.length;r=e;t--){var n=this.uncheckedNodes[t],r=n.child.toString();r in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[r]:(n.child._str=r,this.minimizedNodes[r]=n.child),this.uncheckedNodes.pop()}},B.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},B.Index.prototype.search=function(e){return this.query((function(t){new B.QueryParser(e,t).parse()}))},B.Index.prototype.query=function(e){for(var t=new B.Query(this.fields),n=Object.create(null),r=Object.create(null),a=Object.create(null),o=Object.create(null),i=Object.create(null),s=0;s1?1:e},B.Builder.prototype.k1=function(e){this._k1=e},B.Builder.prototype.add=function(e,t){var n=e[this._ref],r=Object.keys(this._fields);this._documents[n]=t||{},this.documentCount+=1;for(var a=0;a=this.length)return B.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},B.QueryLexer.prototype.width=function(){return this.pos-this.start},B.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},B.QueryLexer.prototype.backup=function(){this.pos-=1},B.QueryLexer.prototype.acceptDigitRun=function(){var e,t;do{t=(e=this.next()).charCodeAt(0)}while(t>47&&t<58);e!=B.QueryLexer.EOS&&this.backup()},B.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(B.QueryLexer.TERM)),e.ignore(),e.more())return B.QueryLexer.lexText},B.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(B.QueryLexer.EDIT_DISTANCE),B.QueryLexer.lexText},B.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(B.QueryLexer.BOOST),B.QueryLexer.lexText},B.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(B.QueryLexer.TERM)},B.QueryLexer.termSeparator=B.tokenizer.separator,B.QueryLexer.lexText=function(e){for(;;){var t=e.next();if(t==B.QueryLexer.EOS)return B.QueryLexer.lexEOS;if(92!=t.charCodeAt(0)){if(":"==t)return B.QueryLexer.lexField;if("~"==t)return e.backup(),e.width()>0&&e.emit(B.QueryLexer.TERM),B.QueryLexer.lexEditDistance;if("^"==t)return e.backup(),e.width()>0&&e.emit(B.QueryLexer.TERM),B.QueryLexer.lexBoost;if("+"==t&&1===e.width())return e.emit(B.QueryLexer.PRESENCE),B.QueryLexer.lexText;if("-"==t&&1===e.width())return e.emit(B.QueryLexer.PRESENCE),B.QueryLexer.lexText;if(t.match(B.QueryLexer.termSeparator))return B.QueryLexer.lexTerm}else e.escapeCharacter()}},B.QueryParser=function(e,t){this.lexer=new B.QueryLexer(e),this.query=t,this.currentClause={},this.lexemeIdx=0},B.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=B.QueryParser.parseClause;e;)e=e(this);return this.query},B.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},B.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},B.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},B.QueryParser.parseClause=function(e){var t=e.peekLexeme();if(null!=t)switch(t.type){case B.QueryLexer.PRESENCE:return B.QueryParser.parsePresence;case B.QueryLexer.FIELD:return B.QueryParser.parseField;case B.QueryLexer.TERM:return B.QueryParser.parseTerm;default:var n="expected either a field or a term, found "+t.type;throw t.str.length>=1&&(n+=" with value '"+t.str+"'"),new B.QueryParseError(n,t.start,t.end)}},B.QueryParser.parsePresence=function(e){var t=e.consumeLexeme();if(null!=t){switch(t.str){case"-":e.currentClause.presence=B.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=B.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+t.str+"'";throw new B.QueryParseError(n,t.start,t.end)}var r=e.peekLexeme();if(null==r){n="expecting term or field, found nothing";throw new B.QueryParseError(n,t.start,t.end)}switch(r.type){case B.QueryLexer.FIELD:return B.QueryParser.parseField;case B.QueryLexer.TERM:return B.QueryParser.parseTerm;default:n="expecting term or field, found '"+r.type+"'";throw new B.QueryParseError(n,r.start,r.end)}}},B.QueryParser.parseField=function(e){var t=e.consumeLexeme();if(null!=t){if(-1==e.query.allFields.indexOf(t.str)){var n=e.query.allFields.map((function(e){return"'"+e+"'"})).join(", "),r="unrecognised field '"+t.str+"', possible fields: "+n;throw new B.QueryParseError(r,t.start,t.end)}e.currentClause.fields=[t.str];var a=e.peekLexeme();if(null==a){r="expecting term, found nothing";throw new B.QueryParseError(r,t.start,t.end)}if(a.type===B.QueryLexer.TERM)return B.QueryParser.parseTerm;r="expecting term, found '"+a.type+"'";throw new B.QueryParseError(r,a.start,a.end)}},B.QueryParser.parseTerm=function(e){var t=e.consumeLexeme();if(null!=t){e.currentClause.term=t.str.toLowerCase(),-1!=t.str.indexOf("*")&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(null!=n)switch(n.type){case B.QueryLexer.TERM:return e.nextClause(),B.QueryParser.parseTerm;case B.QueryLexer.FIELD:return e.nextClause(),B.QueryParser.parseField;case B.QueryLexer.EDIT_DISTANCE:return B.QueryParser.parseEditDistance;case B.QueryLexer.BOOST:return B.QueryParser.parseBoost;case B.QueryLexer.PRESENCE:return e.nextClause(),B.QueryParser.parsePresence;default:var r="Unexpected lexeme type '"+n.type+"'";throw new B.QueryParseError(r,n.start,n.end)}else e.nextClause()}},B.QueryParser.parseEditDistance=function(e){var t=e.consumeLexeme();if(null!=t){var n=parseInt(t.str,10);if(isNaN(n)){var r="edit distance must be numeric";throw new B.QueryParseError(r,t.start,t.end)}e.currentClause.editDistance=n;var a=e.peekLexeme();if(null!=a)switch(a.type){case B.QueryLexer.TERM:return e.nextClause(),B.QueryParser.parseTerm;case B.QueryLexer.FIELD:return e.nextClause(),B.QueryParser.parseField;case B.QueryLexer.EDIT_DISTANCE:return B.QueryParser.parseEditDistance;case B.QueryLexer.BOOST:return B.QueryParser.parseBoost;case B.QueryLexer.PRESENCE:return e.nextClause(),B.QueryParser.parsePresence;default:r="Unexpected lexeme type '"+a.type+"'";throw new B.QueryParseError(r,a.start,a.end)}else e.nextClause()}},B.QueryParser.parseBoost=function(e){var t=e.consumeLexeme();if(null!=t){var n=parseInt(t.str,10);if(isNaN(n)){var r="boost must be numeric";throw new B.QueryParseError(r,t.start,t.end)}e.currentClause.boost=n;var a=e.peekLexeme();if(null!=a)switch(a.type){case B.QueryLexer.TERM:return e.nextClause(),B.QueryParser.parseTerm;case B.QueryLexer.FIELD:return e.nextClause(),B.QueryParser.parseField;case B.QueryLexer.EDIT_DISTANCE:return B.QueryParser.parseEditDistance;case B.QueryLexer.BOOST:return B.QueryParser.parseBoost;case B.QueryLexer.PRESENCE:return e.nextClause(),B.QueryParser.parsePresence;default:r="Unexpected lexeme type '"+a.type+"'";throw new B.QueryParseError(r,a.start,a.end)}else e.nextClause()}},void 0===(a="function"==typeof(r=function(){return B})?r.call(t,n,t,e):r)||(e.exports=a)}()},2497:(e,t,n)=>{"use strict";n.r(t)},2295:(e,t,n)=>{"use strict";n.r(t)},4865:function(e,t,n){var r,a;r=function(){var e,t,n={version:"0.2.0"},r=n.settings={minimum:.08,easing:"ease",positionUsing:"",speed:200,trickle:!0,trickleRate:.02,trickleSpeed:800,showSpinner:!0,barSelector:'[role="bar"]',spinnerSelector:'[role="spinner"]',parent:"body",template:'
'};function a(e,t,n){return en?n:e}function o(e){return 100*(-1+e)}function i(e,t,n){var a;return(a="translate3d"===r.positionUsing?{transform:"translate3d("+o(e)+"%,0,0)"}:"translate"===r.positionUsing?{transform:"translate("+o(e)+"%,0)"}:{"margin-left":o(e)+"%"}).transition="all "+t+"ms "+n,a}n.configure=function(e){var t,n;for(t in e)void 0!==(n=e[t])&&e.hasOwnProperty(t)&&(r[t]=n);return this},n.status=null,n.set=function(e){var t=n.isStarted();e=a(e,r.minimum,1),n.status=1===e?null:e;var o=n.render(!t),l=o.querySelector(r.barSelector),u=r.speed,d=r.easing;return o.offsetWidth,s((function(t){""===r.positionUsing&&(r.positionUsing=n.getPositioningCSS()),c(l,i(e,u,d)),1===e?(c(o,{transition:"none",opacity:1}),o.offsetWidth,setTimeout((function(){c(o,{transition:"all "+u+"ms linear",opacity:0}),setTimeout((function(){n.remove(),t()}),u)}),u)):setTimeout(t,u)})),this},n.isStarted=function(){return"number"==typeof n.status},n.start=function(){n.status||n.set(0);var e=function(){setTimeout((function(){n.status&&(n.trickle(),e())}),r.trickleSpeed)};return r.trickle&&e(),this},n.done=function(e){return e||n.status?n.inc(.3+.5*Math.random()).set(1):this},n.inc=function(e){var t=n.status;return t?("number"!=typeof e&&(e=(1-t)*a(Math.random()*t,.1,.95)),t=a(t+e,0,.994),n.set(t)):n.start()},n.trickle=function(){return n.inc(Math.random()*r.trickleRate)},e=0,t=0,n.promise=function(r){return r&&"resolved"!==r.state()?(0===t&&n.start(),e++,t++,r.always((function(){0==--t?(e=0,n.done()):n.set((e-t)/e)})),this):this},n.render=function(e){if(n.isRendered())return document.getElementById("nprogress");u(document.documentElement,"nprogress-busy");var t=document.createElement("div");t.id="nprogress",t.innerHTML=r.template;var a,i=t.querySelector(r.barSelector),s=e?"-100":o(n.status||0),l=document.querySelector(r.parent);return c(i,{transition:"all 0 linear",transform:"translate3d("+s+"%,0,0)"}),r.showSpinner||(a=t.querySelector(r.spinnerSelector))&&f(a),l!=document.body&&u(l,"nprogress-custom-parent"),l.appendChild(t),t},n.remove=function(){d(document.documentElement,"nprogress-busy"),d(document.querySelector(r.parent),"nprogress-custom-parent");var e=document.getElementById("nprogress");e&&f(e)},n.isRendered=function(){return!!document.getElementById("nprogress")},n.getPositioningCSS=function(){var e=document.body.style,t="WebkitTransform"in e?"Webkit":"MozTransform"in e?"Moz":"msTransform"in e?"ms":"OTransform"in e?"O":"";return t+"Perspective"in e?"translate3d":t+"Transform"in e?"translate":"margin"};var s=function(){var e=[];function t(){var n=e.shift();n&&n(t)}return function(n){e.push(n),1==e.length&&t()}}(),c=function(){var e=["Webkit","O","Moz","ms"],t={};function n(e){return e.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,(function(e,t){return t.toUpperCase()}))}function r(t){var n=document.body.style;if(t in n)return t;for(var r,a=e.length,o=t.charAt(0).toUpperCase()+t.slice(1);a--;)if((r=e[a]+o)in n)return r;return t}function a(e){return e=n(e),t[e]||(t[e]=r(e))}function o(e,t,n){t=a(t),e.style[t]=n}return function(e,t){var n,r,a=arguments;if(2==a.length)for(n in t)void 0!==(r=t[n])&&t.hasOwnProperty(n)&&o(e,n,r);else o(e,a[1],a[2])}}();function l(e,t){return("string"==typeof e?e:p(e)).indexOf(" "+t+" ")>=0}function u(e,t){var n=p(e),r=n+t;l(n,t)||(e.className=r.substring(1))}function d(e,t){var n,r=p(e);l(e,t)&&(n=r.replace(" "+t+" "," "),e.className=n.substring(1,n.length-1))}function p(e){return(" "+(e.className||"")+" ").replace(/\s+/gi," ")}function f(e){e&&e.parentNode&&e.parentNode.removeChild(e)}return n},void 0===(a="function"==typeof r?r.call(t,n,t,e):r)||(e.exports=a)},7418:e=>{"use strict";var t=Object.getOwnPropertySymbols,n=Object.prototype.hasOwnProperty,r=Object.prototype.propertyIsEnumerable;function a(e){if(null==e)throw new TypeError("Object.assign cannot be called with null or undefined");return Object(e)}e.exports=function(){try{if(!Object.assign)return!1;var e=new String("abc");if(e[5]="de","5"===Object.getOwnPropertyNames(e)[0])return!1;for(var t={},n=0;n<10;n++)t["_"+String.fromCharCode(n)]=n;if("0123456789"!==Object.getOwnPropertyNames(t).map((function(e){return t[e]})).join(""))return!1;var r={};return"abcdefghijklmnopqrst".split("").forEach((function(e){r[e]=e})),"abcdefghijklmnopqrst"===Object.keys(Object.assign({},r)).join("")}catch(a){return!1}}()?Object.assign:function(e,o){for(var i,s,c=a(e),l=1;l{var r=n(5826);e.exports=f,e.exports.parse=o,e.exports.compile=function(e,t){return s(o(e,t),t)},e.exports.tokensToFunction=s,e.exports.tokensToRegExp=p;var a=new RegExp(["(\\\\.)","([\\/.])?(?:(?:\\:(\\w+)(?:\\(((?:\\\\.|[^\\\\()])+)\\))?|\\(((?:\\\\.|[^\\\\()])+)\\))([+*?])?|(\\*))"].join("|"),"g");function o(e,t){for(var n,r=[],o=0,i=0,s="",u=t&&t.delimiter||"/";null!=(n=a.exec(e));){var d=n[0],p=n[1],f=n.index;if(s+=e.slice(i,f),i=f+d.length,p)s+=p[1];else{var h=e[i],m=n[2],g=n[3],b=n[4],y=n[5],v=n[6],w=n[7];s&&(r.push(s),s="");var _=null!=m&&null!=h&&h!==m,k="+"===v||"*"===v,S="?"===v||"*"===v,E=n[2]||u,x=b||y;r.push({name:g||o++,prefix:m||"",delimiter:E,optional:S,repeat:k,partial:_,asterisk:!!w,pattern:x?l(x):w?".*":"[^"+c(E)+"]+?"})}}return i{"use strict";n.d(t,{Z:()=>o});var r=function(){var e=/(?:^|\s)lang(?:uage)?-([\w-]+)(?=\s|$)/i,t=0,n={},r={util:{encode:function e(t){return t instanceof a?new a(t.type,e(t.content),t.alias):Array.isArray(t)?t.map(e):t.replace(/&/g,"&").replace(/=d.reach);S+=k.value.length,k=k.next){var E=k.value;if(t.length>e.length)return;if(!(E instanceof a)){var x,P=1;if(y){if(!(x=o(_,S,e,b))||x.index>=e.length)break;var T=x.index,C=x.index+x[0].length,I=S;for(I+=k.value.length;T>=I;)I+=(k=k.next).value.length;if(S=I-=k.value.length,k.value instanceof a)continue;for(var A=k;A!==t.tail&&(Id.reach&&(d.reach=R);var B=k.prev;if(L&&(B=c(t,B,L),S+=L.length),l(t,B,P),k=c(t,B,new a(p,g?r.tokenize(O,g):O,v,O)),N&&c(t,k,N),P>1){var F={cause:p+","+h,reach:R};i(e,t,n,k.prev,S,F),d&&F.reach>d.reach&&(d.reach=F.reach)}}}}}}function s(){var e={value:null,prev:null,next:null},t={value:null,prev:e,next:null};e.next=t,this.head=e,this.tail=t,this.length=0}function c(e,t,n){var r=t.next,a={value:n,prev:t,next:r};return t.next=a,r.prev=a,e.length++,a}function l(e,t,n){for(var r=t.next,a=0;a"+o.content+""},r}(),a=r;r.default=r,a.languages.markup={comment:{pattern://,greedy:!0},prolog:{pattern:/<\?[\s\S]+?\?>/,greedy:!0},doctype:{pattern:/"'[\]]|"[^"]*"|'[^']*')+(?:\[(?:[^<"'\]]|"[^"]*"|'[^']*'|<(?!!--)|)*\]\s*)?>/i,greedy:!0,inside:{"internal-subset":{pattern:/(^[^\[]*\[)[\s\S]+(?=\]>$)/,lookbehind:!0,greedy:!0,inside:null},string:{pattern:/"[^"]*"|'[^']*'/,greedy:!0},punctuation:/^$|[[\]]/,"doctype-tag":/^DOCTYPE/i,name:/[^\s<>'"]+/}},cdata:{pattern://i,greedy:!0},tag:{pattern:/<\/?(?!\d)[^\s>\/=$<%]+(?:\s(?:\s*[^\s>\/=]+(?:\s*=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+(?=[\s>]))|(?=[\s/>])))+)?\s*\/?>/,greedy:!0,inside:{tag:{pattern:/^<\/?[^\s>\/]+/,inside:{punctuation:/^<\/?/,namespace:/^[^\s>\/:]+:/}},"special-attr":[],"attr-value":{pattern:/=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+)/,inside:{punctuation:[{pattern:/^=/,alias:"attr-equals"},/"|'/]}},punctuation:/\/?>/,"attr-name":{pattern:/[^\s>\/]+/,inside:{namespace:/^[^\s>\/:]+:/}}}},entity:[{pattern:/&[\da-z]{1,8};/i,alias:"named-entity"},/&#x?[\da-f]{1,8};/i]},a.languages.markup.tag.inside["attr-value"].inside.entity=a.languages.markup.entity,a.languages.markup.doctype.inside["internal-subset"].inside=a.languages.markup,a.hooks.add("wrap",(function(e){"entity"===e.type&&(e.attributes.title=e.content.replace(/&/,"&"))})),Object.defineProperty(a.languages.markup.tag,"addInlined",{value:function(e,t){var n={};n["language-"+t]={pattern:/(^$)/i,lookbehind:!0,inside:a.languages[t]},n.cdata=/^$/i;var r={"included-cdata":{pattern://i,inside:n}};r["language-"+t]={pattern:/[\s\S]+/,inside:a.languages[t]};var o={};o[e]={pattern:RegExp(/(<__[^>]*>)(?:))*\]\]>|(?!)/.source.replace(/__/g,(function(){return e})),"i"),lookbehind:!0,greedy:!0,inside:r},a.languages.insertBefore("markup","cdata",o)}}),Object.defineProperty(a.languages.markup.tag,"addAttribute",{value:function(e,t){a.languages.markup.tag.inside["special-attr"].push({pattern:RegExp(/(^|["'\s])/.source+"(?:"+e+")"+/\s*=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+(?=[\s>]))/.source,"i"),lookbehind:!0,inside:{"attr-name":/^[^\s=]+/,"attr-value":{pattern:/=[\s\S]+/,inside:{value:{pattern:/(^=\s*(["']|(?!["'])))\S[\s\S]*(?=\2$)/,lookbehind:!0,alias:[t,"language-"+t],inside:a.languages[t]},punctuation:[{pattern:/^=/,alias:"attr-equals"},/"|'/]}}}})}}),a.languages.html=a.languages.markup,a.languages.mathml=a.languages.markup,a.languages.svg=a.languages.markup,a.languages.xml=a.languages.extend("markup",{}),a.languages.ssml=a.languages.xml,a.languages.atom=a.languages.xml,a.languages.rss=a.languages.xml,function(e){var t="\\b(?:BASH|BASHOPTS|BASH_ALIASES|BASH_ARGC|BASH_ARGV|BASH_CMDS|BASH_COMPLETION_COMPAT_DIR|BASH_LINENO|BASH_REMATCH|BASH_SOURCE|BASH_VERSINFO|BASH_VERSION|COLORTERM|COLUMNS|COMP_WORDBREAKS|DBUS_SESSION_BUS_ADDRESS|DEFAULTS_PATH|DESKTOP_SESSION|DIRSTACK|DISPLAY|EUID|GDMSESSION|GDM_LANG|GNOME_KEYRING_CONTROL|GNOME_KEYRING_PID|GPG_AGENT_INFO|GROUPS|HISTCONTROL|HISTFILE|HISTFILESIZE|HISTSIZE|HOME|HOSTNAME|HOSTTYPE|IFS|INSTANCE|JOB|LANG|LANGUAGE|LC_ADDRESS|LC_ALL|LC_IDENTIFICATION|LC_MEASUREMENT|LC_MONETARY|LC_NAME|LC_NUMERIC|LC_PAPER|LC_TELEPHONE|LC_TIME|LESSCLOSE|LESSOPEN|LINES|LOGNAME|LS_COLORS|MACHTYPE|MAILCHECK|MANDATORY_PATH|NO_AT_BRIDGE|OLDPWD|OPTERR|OPTIND|ORBIT_SOCKETDIR|OSTYPE|PAPERSIZE|PATH|PIPESTATUS|PPID|PS1|PS2|PS3|PS4|PWD|RANDOM|REPLY|SECONDS|SELINUX_INIT|SESSION|SESSIONTYPE|SESSION_MANAGER|SHELL|SHELLOPTS|SHLVL|SSH_AUTH_SOCK|TERM|UID|UPSTART_EVENTS|UPSTART_INSTANCE|UPSTART_JOB|UPSTART_SESSION|USER|WINDOWID|XAUTHORITY|XDG_CONFIG_DIRS|XDG_CURRENT_DESKTOP|XDG_DATA_DIRS|XDG_GREETER_DATA_DIR|XDG_MENU_PREFIX|XDG_RUNTIME_DIR|XDG_SEAT|XDG_SEAT_PATH|XDG_SESSION_DESKTOP|XDG_SESSION_ID|XDG_SESSION_PATH|XDG_SESSION_TYPE|XDG_VTNR|XMODIFIERS)\\b",n={pattern:/(^(["']?)\w+\2)[ \t]+\S.*/,lookbehind:!0,alias:"punctuation",inside:null},r={bash:n,environment:{pattern:RegExp("\\$"+t),alias:"constant"},variable:[{pattern:/\$?\(\([\s\S]+?\)\)/,greedy:!0,inside:{variable:[{pattern:/(^\$\(\([\s\S]+)\)\)/,lookbehind:!0},/^\$\(\(/],number:/\b0x[\dA-Fa-f]+\b|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:[Ee]-?\d+)?/,operator:/--|\+\+|\*\*=?|<<=?|>>=?|&&|\|\||[=!+\-*/%<>^&|]=?|[?~:]/,punctuation:/\(\(?|\)\)?|,|;/}},{pattern:/\$\((?:\([^)]+\)|[^()])+\)|`[^`]+`/,greedy:!0,inside:{variable:/^\$\(|^`|\)$|`$/}},{pattern:/\$\{[^}]+\}/,greedy:!0,inside:{operator:/:[-=?+]?|[!\/]|##?|%%?|\^\^?|,,?/,punctuation:/[\[\]]/,environment:{pattern:RegExp("(\\{)"+t),lookbehind:!0,alias:"constant"}}},/\$(?:\w+|[#?*!@$])/],entity:/\\(?:[abceEfnrtv\\"]|O?[0-7]{1,3}|U[0-9a-fA-F]{8}|u[0-9a-fA-F]{4}|x[0-9a-fA-F]{1,2})/};e.languages.bash={shebang:{pattern:/^#!\s*\/.*/,alias:"important"},comment:{pattern:/(^|[^"{\\$])#.*/,lookbehind:!0},"function-name":[{pattern:/(\bfunction\s+)[\w-]+(?=(?:\s*\(?:\s*\))?\s*\{)/,lookbehind:!0,alias:"function"},{pattern:/\b[\w-]+(?=\s*\(\s*\)\s*\{)/,alias:"function"}],"for-or-select":{pattern:/(\b(?:for|select)\s+)\w+(?=\s+in\s)/,alias:"variable",lookbehind:!0},"assign-left":{pattern:/(^|[\s;|&]|[<>]\()\w+(?=\+?=)/,inside:{environment:{pattern:RegExp("(^|[\\s;|&]|[<>]\\()"+t),lookbehind:!0,alias:"constant"}},alias:"variable",lookbehind:!0},string:[{pattern:/((?:^|[^<])<<-?\s*)(\w+)\s[\s\S]*?(?:\r?\n|\r)\2/,lookbehind:!0,greedy:!0,inside:r},{pattern:/((?:^|[^<])<<-?\s*)(["'])(\w+)\2\s[\s\S]*?(?:\r?\n|\r)\3/,lookbehind:!0,greedy:!0,inside:{bash:n}},{pattern:/(^|[^\\](?:\\\\)*)"(?:\\[\s\S]|\$\([^)]+\)|\$(?!\()|`[^`]+`|[^"\\`$])*"/,lookbehind:!0,greedy:!0,inside:r},{pattern:/(^|[^$\\])'[^']*'/,lookbehind:!0,greedy:!0},{pattern:/\$'(?:[^'\\]|\\[\s\S])*'/,greedy:!0,inside:{entity:r.entity}}],environment:{pattern:RegExp("\\$?"+t),alias:"constant"},variable:r.variable,function:{pattern:/(^|[\s;|&]|[<>]\()(?:add|apropos|apt|apt-cache|apt-get|aptitude|aspell|automysqlbackup|awk|basename|bash|bc|bconsole|bg|bzip2|cal|cat|cfdisk|chgrp|chkconfig|chmod|chown|chroot|cksum|clear|cmp|column|comm|composer|cp|cron|crontab|csplit|curl|cut|date|dc|dd|ddrescue|debootstrap|df|diff|diff3|dig|dir|dircolors|dirname|dirs|dmesg|docker|docker-compose|du|egrep|eject|env|ethtool|expand|expect|expr|fdformat|fdisk|fg|fgrep|file|find|fmt|fold|format|free|fsck|ftp|fuser|gawk|git|gparted|grep|groupadd|groupdel|groupmod|groups|grub-mkconfig|gzip|halt|head|hg|history|host|hostname|htop|iconv|id|ifconfig|ifdown|ifup|import|install|ip|jobs|join|kill|killall|less|link|ln|locate|logname|logrotate|look|lpc|lpr|lprint|lprintd|lprintq|lprm|ls|lsof|lynx|make|man|mc|mdadm|mkconfig|mkdir|mke2fs|mkfifo|mkfs|mkisofs|mknod|mkswap|mmv|more|most|mount|mtools|mtr|mutt|mv|nano|nc|netstat|nice|nl|node|nohup|notify-send|npm|nslookup|op|open|parted|passwd|paste|pathchk|ping|pkill|pnpm|podman|podman-compose|popd|pr|printcap|printenv|ps|pushd|pv|quota|quotacheck|quotactl|ram|rar|rcp|reboot|remsync|rename|renice|rev|rm|rmdir|rpm|rsync|scp|screen|sdiff|sed|sendmail|seq|service|sftp|sh|shellcheck|shuf|shutdown|sleep|slocate|sort|split|ssh|stat|strace|su|sudo|sum|suspend|swapon|sync|tac|tail|tar|tee|time|timeout|top|touch|tr|traceroute|tsort|tty|umount|uname|unexpand|uniq|units|unrar|unshar|unzip|update-grub|uptime|useradd|userdel|usermod|users|uudecode|uuencode|v|vcpkg|vdir|vi|vim|virsh|vmstat|wait|watch|wc|wget|whereis|which|who|whoami|write|xargs|xdg-open|yarn|yes|zenity|zip|zsh|zypper)(?=$|[)\s;|&])/,lookbehind:!0},keyword:{pattern:/(^|[\s;|&]|[<>]\()(?:case|do|done|elif|else|esac|fi|for|function|if|in|select|then|until|while)(?=$|[)\s;|&])/,lookbehind:!0},builtin:{pattern:/(^|[\s;|&]|[<>]\()(?:\.|:|alias|bind|break|builtin|caller|cd|command|continue|declare|echo|enable|eval|exec|exit|export|getopts|hash|help|let|local|logout|mapfile|printf|pwd|read|readarray|readonly|return|set|shift|shopt|source|test|times|trap|type|typeset|ulimit|umask|unalias|unset)(?=$|[)\s;|&])/,lookbehind:!0,alias:"class-name"},boolean:{pattern:/(^|[\s;|&]|[<>]\()(?:false|true)(?=$|[)\s;|&])/,lookbehind:!0},"file-descriptor":{pattern:/\B&\d\b/,alias:"important"},operator:{pattern:/\d?<>|>\||\+=|=[=~]?|!=?|<<[<-]?|[&\d]?>>|\d[<>]&?|[<>][&=]?|&[>&]?|\|[&|]?/,inside:{"file-descriptor":{pattern:/^\d/,alias:"important"}}},punctuation:/\$?\(\(?|\)\)?|\.\.|[{}[\];\\]/,number:{pattern:/(^|\s)(?:[1-9]\d*|0)(?:[.,]\d+)?\b/,lookbehind:!0}},n.inside=e.languages.bash;for(var a=["comment","function-name","for-or-select","assign-left","string","environment","function","keyword","builtin","boolean","file-descriptor","operator","punctuation","number"],o=r.variable[1].inside,i=0;i]=?|[!=]=?=?|--?|\+\+?|&&?|\|\|?|[?*/~^%]/,punctuation:/[{}[\];(),.:]/},a.languages.c=a.languages.extend("clike",{comment:{pattern:/\/\/(?:[^\r\n\\]|\\(?:\r\n?|\n|(?![\r\n])))*|\/\*[\s\S]*?(?:\*\/|$)/,greedy:!0},string:{pattern:/"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"/,greedy:!0},"class-name":{pattern:/(\b(?:enum|struct)\s+(?:__attribute__\s*\(\([\s\S]*?\)\)\s*)?)\w+|\b[a-z]\w*_t\b/,lookbehind:!0},keyword:/\b(?:_Alignas|_Alignof|_Atomic|_Bool|_Complex|_Generic|_Imaginary|_Noreturn|_Static_assert|_Thread_local|__attribute__|asm|auto|break|case|char|const|continue|default|do|double|else|enum|extern|float|for|goto|if|inline|int|long|register|return|short|signed|sizeof|static|struct|switch|typedef|typeof|union|unsigned|void|volatile|while)\b/,function:/\b[a-z_]\w*(?=\s*\()/i,number:/(?:\b0x(?:[\da-f]+(?:\.[\da-f]*)?|\.[\da-f]+)(?:p[+-]?\d+)?|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:e[+-]?\d+)?)[ful]{0,4}/i,operator:/>>=?|<<=?|->|([-+&|:])\1|[?:~]|[-+*/%&|^!=<>]=?/}),a.languages.insertBefore("c","string",{char:{pattern:/'(?:\\(?:\r\n|[\s\S])|[^'\\\r\n]){0,32}'/,greedy:!0}}),a.languages.insertBefore("c","string",{macro:{pattern:/(^[\t ]*)#\s*[a-z](?:[^\r\n\\/]|\/(?!\*)|\/\*(?:[^*]|\*(?!\/))*\*\/|\\(?:\r\n|[\s\S]))*/im,lookbehind:!0,greedy:!0,alias:"property",inside:{string:[{pattern:/^(#\s*include\s*)<[^>]+>/,lookbehind:!0},a.languages.c.string],char:a.languages.c.char,comment:a.languages.c.comment,"macro-name":[{pattern:/(^#\s*define\s+)\w+\b(?!\()/i,lookbehind:!0},{pattern:/(^#\s*define\s+)\w+\b(?=\()/i,lookbehind:!0,alias:"function"}],directive:{pattern:/^(#\s*)[a-z]+/,lookbehind:!0,alias:"keyword"},"directive-hash":/^#/,punctuation:/##|\\(?=[\r\n])/,expression:{pattern:/\S[\s\S]*/,inside:a.languages.c}}}}),a.languages.insertBefore("c","function",{constant:/\b(?:EOF|NULL|SEEK_CUR|SEEK_END|SEEK_SET|__DATE__|__FILE__|__LINE__|__TIMESTAMP__|__TIME__|__func__|stderr|stdin|stdout)\b/}),delete a.languages.c.boolean,function(e){var t=/\b(?:alignas|alignof|asm|auto|bool|break|case|catch|char|char16_t|char32_t|char8_t|class|co_await|co_return|co_yield|compl|concept|const|const_cast|consteval|constexpr|constinit|continue|decltype|default|delete|do|double|dynamic_cast|else|enum|explicit|export|extern|final|float|for|friend|goto|if|import|inline|int|int16_t|int32_t|int64_t|int8_t|long|module|mutable|namespace|new|noexcept|nullptr|operator|override|private|protected|public|register|reinterpret_cast|requires|return|short|signed|sizeof|static|static_assert|static_cast|struct|switch|template|this|thread_local|throw|try|typedef|typeid|typename|uint16_t|uint32_t|uint64_t|uint8_t|union|unsigned|using|virtual|void|volatile|wchar_t|while)\b/,n=/\b(?!)\w+(?:\s*\.\s*\w+)*\b/.source.replace(//g,(function(){return t.source}));e.languages.cpp=e.languages.extend("c",{"class-name":[{pattern:RegExp(/(\b(?:class|concept|enum|struct|typename)\s+)(?!)\w+/.source.replace(//g,(function(){return t.source}))),lookbehind:!0},/\b[A-Z]\w*(?=\s*::\s*\w+\s*\()/,/\b[A-Z_]\w*(?=\s*::\s*~\w+\s*\()/i,/\b\w+(?=\s*<(?:[^<>]|<(?:[^<>]|<[^<>]*>)*>)*>\s*::\s*\w+\s*\()/],keyword:t,number:{pattern:/(?:\b0b[01']+|\b0x(?:[\da-f']+(?:\.[\da-f']*)?|\.[\da-f']+)(?:p[+-]?[\d']+)?|(?:\b[\d']+(?:\.[\d']*)?|\B\.[\d']+)(?:e[+-]?[\d']+)?)[ful]{0,4}/i,greedy:!0},operator:/>>=?|<<=?|->|--|\+\+|&&|\|\||[?:~]|<=>|[-+*/%&|^!=<>]=?|\b(?:and|and_eq|bitand|bitor|not|not_eq|or|or_eq|xor|xor_eq)\b/,boolean:/\b(?:false|true)\b/}),e.languages.insertBefore("cpp","string",{module:{pattern:RegExp(/(\b(?:import|module)\s+)/.source+"(?:"+/"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"|<[^<>\r\n]*>/.source+"|"+/(?:\s*:\s*)?|:\s*/.source.replace(//g,(function(){return n}))+")"),lookbehind:!0,greedy:!0,inside:{string:/^[<"][\s\S]+/,operator:/:/,punctuation:/\./}},"raw-string":{pattern:/R"([^()\\ ]{0,16})\([\s\S]*?\)\1"/,alias:"string",greedy:!0}}),e.languages.insertBefore("cpp","keyword",{"generic-function":{pattern:/\b(?!operator\b)[a-z_]\w*\s*<(?:[^<>]|<[^<>]*>)*>(?=\s*\()/i,inside:{function:/^\w+/,generic:{pattern:/<[\s\S]+/,alias:"class-name",inside:e.languages.cpp}}}}),e.languages.insertBefore("cpp","operator",{"double-colon":{pattern:/::/,alias:"punctuation"}}),e.languages.insertBefore("cpp","class-name",{"base-clause":{pattern:/(\b(?:class|struct)\s+\w+\s*:\s*)[^;{}"'\s]+(?:\s+[^;{}"'\s]+)*(?=\s*[;{])/,lookbehind:!0,greedy:!0,inside:e.languages.extend("cpp",{})}}),e.languages.insertBefore("inside","double-colon",{"class-name":/\b[a-z_]\w*\b(?!\s*::)/i},e.languages.cpp["base-clause"])}(a),function(e){var t=/(?:"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"|'(?:\\(?:\r\n|[\s\S])|[^'\\\r\n])*')/;e.languages.css={comment:/\/\*[\s\S]*?\*\//,atrule:{pattern:/@[\w-](?:[^;{\s]|\s+(?![\s{]))*(?:;|(?=\s*\{))/,inside:{rule:/^@[\w-]+/,"selector-function-argument":{pattern:/(\bselector\s*\(\s*(?![\s)]))(?:[^()\s]|\s+(?![\s)])|\((?:[^()]|\([^()]*\))*\))+(?=\s*\))/,lookbehind:!0,alias:"selector"},keyword:{pattern:/(^|[^\w-])(?:and|not|only|or)(?![\w-])/,lookbehind:!0}}},url:{pattern:RegExp("\\burl\\((?:"+t.source+"|"+/(?:[^\\\r\n()"']|\\[\s\S])*/.source+")\\)","i"),greedy:!0,inside:{function:/^url/i,punctuation:/^\(|\)$/,string:{pattern:RegExp("^"+t.source+"$"),alias:"url"}}},selector:{pattern:RegExp("(^|[{}\\s])[^{}\\s](?:[^{};\"'\\s]|\\s+(?![\\s{])|"+t.source+")*(?=\\s*\\{)"),lookbehind:!0},string:{pattern:t,greedy:!0},property:{pattern:/(^|[^-\w\xA0-\uFFFF])(?!\s)[-_a-z\xA0-\uFFFF](?:(?!\s)[-\w\xA0-\uFFFF])*(?=\s*:)/i,lookbehind:!0},important:/!important\b/i,function:{pattern:/(^|[^-a-z0-9])[-a-z0-9]+(?=\()/i,lookbehind:!0},punctuation:/[(){};:,]/},e.languages.css.atrule.inside.rest=e.languages.css;var n=e.languages.markup;n&&(n.tag.addInlined("style","css"),n.tag.addAttribute("style","css"))}(a),function(e){var t,n=/("|')(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/;e.languages.css.selector={pattern:e.languages.css.selector.pattern,lookbehind:!0,inside:t={"pseudo-element":/:(?:after|before|first-letter|first-line|selection)|::[-\w]+/,"pseudo-class":/:[-\w]+/,class:/\.[-\w]+/,id:/#[-\w]+/,attribute:{pattern:RegExp("\\[(?:[^[\\]\"']|"+n.source+")*\\]"),greedy:!0,inside:{punctuation:/^\[|\]$/,"case-sensitivity":{pattern:/(\s)[si]$/i,lookbehind:!0,alias:"keyword"},namespace:{pattern:/^(\s*)(?:(?!\s)[-*\w\xA0-\uFFFF])*\|(?!=)/,lookbehind:!0,inside:{punctuation:/\|$/}},"attr-name":{pattern:/^(\s*)(?:(?!\s)[-\w\xA0-\uFFFF])+/,lookbehind:!0},"attr-value":[n,{pattern:/(=\s*)(?:(?!\s)[-\w\xA0-\uFFFF])+(?=\s*$)/,lookbehind:!0}],operator:/[|~*^$]?=/}},"n-th":[{pattern:/(\(\s*)[+-]?\d*[\dn](?:\s*[+-]\s*\d+)?(?=\s*\))/,lookbehind:!0,inside:{number:/[\dn]+/,operator:/[+-]/}},{pattern:/(\(\s*)(?:even|odd)(?=\s*\))/i,lookbehind:!0}],combinator:/>|\+|~|\|\|/,punctuation:/[(),]/}},e.languages.css.atrule.inside["selector-function-argument"].inside=t,e.languages.insertBefore("css","property",{variable:{pattern:/(^|[^-\w\xA0-\uFFFF])--(?!\s)[-_a-z\xA0-\uFFFF](?:(?!\s)[-\w\xA0-\uFFFF])*/i,lookbehind:!0}});var r={pattern:/(\b\d+)(?:%|[a-z]+(?![\w-]))/,lookbehind:!0},a={pattern:/(^|[^\w.-])-?(?:\d+(?:\.\d+)?|\.\d+)/,lookbehind:!0};e.languages.insertBefore("css","function",{operator:{pattern:/(\s)[+\-*\/](?=\s)/,lookbehind:!0},hexcode:{pattern:/\B#[\da-f]{3,8}\b/i,alias:"color"},color:[{pattern:/(^|[^\w-])(?:AliceBlue|AntiqueWhite|Aqua|Aquamarine|Azure|Beige|Bisque|Black|BlanchedAlmond|Blue|BlueViolet|Brown|BurlyWood|CadetBlue|Chartreuse|Chocolate|Coral|CornflowerBlue|Cornsilk|Crimson|Cyan|DarkBlue|DarkCyan|DarkGoldenRod|DarkGr[ae]y|DarkGreen|DarkKhaki|DarkMagenta|DarkOliveGreen|DarkOrange|DarkOrchid|DarkRed|DarkSalmon|DarkSeaGreen|DarkSlateBlue|DarkSlateGr[ae]y|DarkTurquoise|DarkViolet|DeepPink|DeepSkyBlue|DimGr[ae]y|DodgerBlue|FireBrick|FloralWhite|ForestGreen|Fuchsia|Gainsboro|GhostWhite|Gold|GoldenRod|Gr[ae]y|Green|GreenYellow|HoneyDew|HotPink|IndianRed|Indigo|Ivory|Khaki|Lavender|LavenderBlush|LawnGreen|LemonChiffon|LightBlue|LightCoral|LightCyan|LightGoldenRodYellow|LightGr[ae]y|LightGreen|LightPink|LightSalmon|LightSeaGreen|LightSkyBlue|LightSlateGr[ae]y|LightSteelBlue|LightYellow|Lime|LimeGreen|Linen|Magenta|Maroon|MediumAquaMarine|MediumBlue|MediumOrchid|MediumPurple|MediumSeaGreen|MediumSlateBlue|MediumSpringGreen|MediumTurquoise|MediumVioletRed|MidnightBlue|MintCream|MistyRose|Moccasin|NavajoWhite|Navy|OldLace|Olive|OliveDrab|Orange|OrangeRed|Orchid|PaleGoldenRod|PaleGreen|PaleTurquoise|PaleVioletRed|PapayaWhip|PeachPuff|Peru|Pink|Plum|PowderBlue|Purple|Red|RosyBrown|RoyalBlue|SaddleBrown|Salmon|SandyBrown|SeaGreen|SeaShell|Sienna|Silver|SkyBlue|SlateBlue|SlateGr[ae]y|Snow|SpringGreen|SteelBlue|Tan|Teal|Thistle|Tomato|Transparent|Turquoise|Violet|Wheat|White|WhiteSmoke|Yellow|YellowGreen)(?![\w-])/i,lookbehind:!0},{pattern:/\b(?:hsl|rgb)\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*\)\B|\b(?:hsl|rgb)a\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*,\s*(?:0|0?\.\d+|1)\s*\)\B/i,inside:{unit:r,number:a,function:/[\w-]+(?=\()/,punctuation:/[(),]/}}],entity:/\\[\da-f]{1,8}/i,unit:r,number:a})}(a),a.languages.javascript=a.languages.extend("clike",{"class-name":[a.languages.clike["class-name"],{pattern:/(^|[^$\w\xA0-\uFFFF])(?!\s)[_$A-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\.(?:constructor|prototype))/,lookbehind:!0}],keyword:[{pattern:/((?:^|\})\s*)catch\b/,lookbehind:!0},{pattern:/(^|[^.]|\.\.\.\s*)\b(?:as|assert(?=\s*\{)|async(?=\s*(?:function\b|\(|[$\w\xA0-\uFFFF]|$))|await|break|case|class|const|continue|debugger|default|delete|do|else|enum|export|extends|finally(?=\s*(?:\{|$))|for|from(?=\s*(?:['"]|$))|function|(?:get|set)(?=\s*(?:[#\[$\w\xA0-\uFFFF]|$))|if|implements|import|in|instanceof|interface|let|new|null|of|package|private|protected|public|return|static|super|switch|this|throw|try|typeof|undefined|var|void|while|with|yield)\b/,lookbehind:!0}],function:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*(?:\.\s*(?:apply|bind|call)\s*)?\()/,number:{pattern:RegExp(/(^|[^\w$])/.source+"(?:"+/NaN|Infinity/.source+"|"+/0[bB][01]+(?:_[01]+)*n?/.source+"|"+/0[oO][0-7]+(?:_[0-7]+)*n?/.source+"|"+/0[xX][\dA-Fa-f]+(?:_[\dA-Fa-f]+)*n?/.source+"|"+/\d+(?:_\d+)*n/.source+"|"+/(?:\d+(?:_\d+)*(?:\.(?:\d+(?:_\d+)*)?)?|\.\d+(?:_\d+)*)(?:[Ee][+-]?\d+(?:_\d+)*)?/.source+")"+/(?![\w$])/.source),lookbehind:!0},operator:/--|\+\+|\*\*=?|=>|&&=?|\|\|=?|[!=]==|<<=?|>>>?=?|[-+*/%&|^!=<>]=?|\.{3}|\?\?=?|\?\.?|[~:]/}),a.languages.javascript["class-name"][0].pattern=/(\b(?:class|extends|implements|instanceof|interface|new)\s+)[\w.\\]+/,a.languages.insertBefore("javascript","keyword",{regex:{pattern:/((?:^|[^$\w\xA0-\uFFFF."'\])\s]|\b(?:return|yield))\s*)\/(?:\[(?:[^\]\\\r\n]|\\.)*\]|\\.|[^/\\\[\r\n])+\/[dgimyus]{0,7}(?=(?:\s|\/\*(?:[^*]|\*(?!\/))*\*\/)*(?:$|[\r\n,.;:})\]]|\/\/))/,lookbehind:!0,greedy:!0,inside:{"regex-source":{pattern:/^(\/)[\s\S]+(?=\/[a-z]*$)/,lookbehind:!0,alias:"language-regex",inside:a.languages.regex},"regex-delimiter":/^\/|\/$/,"regex-flags":/^[a-z]+$/}},"function-variable":{pattern:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*[=:]\s*(?:async\s*)?(?:\bfunction\b|(?:\((?:[^()]|\([^()]*\))*\)|(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*)\s*=>))/,alias:"function"},parameter:[{pattern:/(function(?:\s+(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*)?\s*\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\))/,lookbehind:!0,inside:a.languages.javascript},{pattern:/(^|[^$\w\xA0-\uFFFF])(?!\s)[_$a-z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*=>)/i,lookbehind:!0,inside:a.languages.javascript},{pattern:/(\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\)\s*=>)/,lookbehind:!0,inside:a.languages.javascript},{pattern:/((?:\b|\s|^)(?!(?:as|async|await|break|case|catch|class|const|continue|debugger|default|delete|do|else|enum|export|extends|finally|for|from|function|get|if|implements|import|in|instanceof|interface|let|new|null|of|package|private|protected|public|return|set|static|super|switch|this|throw|try|typeof|undefined|var|void|while|with|yield)(?![$\w\xA0-\uFFFF]))(?:(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*\s*)\(\s*|\]\s*\(\s*)(?!\s)(?:[^()\s]|\s+(?![\s)])|\([^()]*\))+(?=\s*\)\s*\{)/,lookbehind:!0,inside:a.languages.javascript}],constant:/\b[A-Z](?:[A-Z_]|\dx?)*\b/}),a.languages.insertBefore("javascript","string",{hashbang:{pattern:/^#!.*/,greedy:!0,alias:"comment"},"template-string":{pattern:/`(?:\\[\s\S]|\$\{(?:[^{}]|\{(?:[^{}]|\{[^}]*\})*\})+\}|(?!\$\{)[^\\`])*`/,greedy:!0,inside:{"template-punctuation":{pattern:/^`|`$/,alias:"string"},interpolation:{pattern:/((?:^|[^\\])(?:\\{2})*)\$\{(?:[^{}]|\{(?:[^{}]|\{[^}]*\})*\})+\}/,lookbehind:!0,inside:{"interpolation-punctuation":{pattern:/^\$\{|\}$/,alias:"punctuation"},rest:a.languages.javascript}},string:/[\s\S]+/}},"string-property":{pattern:/((?:^|[,{])[ \t]*)(["'])(?:\\(?:\r\n|[\s\S])|(?!\2)[^\\\r\n])*\2(?=\s*:)/m,lookbehind:!0,greedy:!0,alias:"property"}}),a.languages.insertBefore("javascript","operator",{"literal-property":{pattern:/((?:^|[,{])[ \t]*)(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*:)/m,lookbehind:!0,alias:"property"}}),a.languages.markup&&(a.languages.markup.tag.addInlined("script","javascript"),a.languages.markup.tag.addAttribute(/on(?:abort|blur|change|click|composition(?:end|start|update)|dblclick|error|focus(?:in|out)?|key(?:down|up)|load|mouse(?:down|enter|leave|move|out|over|up)|reset|resize|scroll|select|slotchange|submit|unload|wheel)/.source,"javascript")),a.languages.js=a.languages.javascript,function(e){var t=/#(?!\{).+/,n={pattern:/#\{[^}]+\}/,alias:"variable"};e.languages.coffeescript=e.languages.extend("javascript",{comment:t,string:[{pattern:/'(?:\\[\s\S]|[^\\'])*'/,greedy:!0},{pattern:/"(?:\\[\s\S]|[^\\"])*"/,greedy:!0,inside:{interpolation:n}}],keyword:/\b(?:and|break|by|catch|class|continue|debugger|delete|do|each|else|extend|extends|false|finally|for|if|in|instanceof|is|isnt|let|loop|namespace|new|no|not|null|of|off|on|or|own|return|super|switch|then|this|throw|true|try|typeof|undefined|unless|until|when|while|window|with|yes|yield)\b/,"class-member":{pattern:/@(?!\d)\w+/,alias:"variable"}}),e.languages.insertBefore("coffeescript","comment",{"multiline-comment":{pattern:/###[\s\S]+?###/,alias:"comment"},"block-regex":{pattern:/\/{3}[\s\S]*?\/{3}/,alias:"regex",inside:{comment:t,interpolation:n}}}),e.languages.insertBefore("coffeescript","string",{"inline-javascript":{pattern:/`(?:\\[\s\S]|[^\\`])*`/,inside:{delimiter:{pattern:/^`|`$/,alias:"punctuation"},script:{pattern:/[\s\S]+/,alias:"language-javascript",inside:e.languages.javascript}}},"multiline-string":[{pattern:/'''[\s\S]*?'''/,greedy:!0,alias:"string"},{pattern:/"""[\s\S]*?"""/,greedy:!0,alias:"string",inside:{interpolation:n}}]}),e.languages.insertBefore("coffeescript","keyword",{property:/(?!\d)\w+(?=\s*:(?!:))/}),delete e.languages.coffeescript["template-string"],e.languages.coffee=e.languages.coffeescript}(a),function(e){var t=/[*&][^\s[\]{},]+/,n=/!(?:<[\w\-%#;/?:@&=+$,.!~*'()[\]]+>|(?:[a-zA-Z\d-]*!)?[\w\-%#;/?:@&=+$.~*'()]+)?/,r="(?:"+n.source+"(?:[ \t]+"+t.source+")?|"+t.source+"(?:[ \t]+"+n.source+")?)",a=/(?:[^\s\x00-\x08\x0e-\x1f!"#%&'*,\-:>?@[\]`{|}\x7f-\x84\x86-\x9f\ud800-\udfff\ufffe\uffff]|[?:-])(?:[ \t]*(?:(?![#:])|:))*/.source.replace(//g,(function(){return/[^\s\x00-\x08\x0e-\x1f,[\]{}\x7f-\x84\x86-\x9f\ud800-\udfff\ufffe\uffff]/.source})),o=/"(?:[^"\\\r\n]|\\.)*"|'(?:[^'\\\r\n]|\\.)*'/.source;function i(e,t){t=(t||"").replace(/m/g,"")+"m";var n=/([:\-,[{]\s*(?:\s<>[ \t]+)?)(?:<>)(?=[ \t]*(?:$|,|\]|\}|(?:[\r\n]\s*)?#))/.source.replace(/<>/g,(function(){return r})).replace(/<>/g,(function(){return e}));return RegExp(n,t)}e.languages.yaml={scalar:{pattern:RegExp(/([\-:]\s*(?:\s<>[ \t]+)?[|>])[ \t]*(?:((?:\r?\n|\r)[ \t]+)\S[^\r\n]*(?:\2[^\r\n]+)*)/.source.replace(/<>/g,(function(){return r}))),lookbehind:!0,alias:"string"},comment:/#.*/,key:{pattern:RegExp(/((?:^|[:\-,[{\r\n?])[ \t]*(?:<>[ \t]+)?)<>(?=\s*:\s)/.source.replace(/<>/g,(function(){return r})).replace(/<>/g,(function(){return"(?:"+a+"|"+o+")"}))),lookbehind:!0,greedy:!0,alias:"atrule"},directive:{pattern:/(^[ \t]*)%.+/m,lookbehind:!0,alias:"important"},datetime:{pattern:i(/\d{4}-\d\d?-\d\d?(?:[tT]|[ \t]+)\d\d?:\d{2}:\d{2}(?:\.\d*)?(?:[ \t]*(?:Z|[-+]\d\d?(?::\d{2})?))?|\d{4}-\d{2}-\d{2}|\d\d?:\d{2}(?::\d{2}(?:\.\d*)?)?/.source),lookbehind:!0,alias:"number"},boolean:{pattern:i(/false|true/.source,"i"),lookbehind:!0,alias:"important"},null:{pattern:i(/null|~/.source,"i"),lookbehind:!0,alias:"important"},string:{pattern:i(o),lookbehind:!0,greedy:!0},number:{pattern:i(/[+-]?(?:0x[\da-f]+|0o[0-7]+|(?:\d+(?:\.\d*)?|\.\d+)(?:e[+-]?\d+)?|\.inf|\.nan)/.source,"i"),lookbehind:!0},tag:n,important:t,punctuation:/---|[:[\]{}\-,|>?]|\.\.\./},e.languages.yml=e.languages.yaml}(a),function(e){var t=/(?:\\.|[^\\\n\r]|(?:\n|\r\n?)(?![\r\n]))/.source;function n(e){return e=e.replace(//g,(function(){return t})),RegExp(/((?:^|[^\\])(?:\\{2})*)/.source+"(?:"+e+")")}var r=/(?:\\.|``(?:[^`\r\n]|`(?!`))+``|`[^`\r\n]+`|[^\\|\r\n`])+/.source,a=/\|?__(?:\|__)+\|?(?:(?:\n|\r\n?)|(?![\s\S]))/.source.replace(/__/g,(function(){return r})),o=/\|?[ \t]*:?-{3,}:?[ \t]*(?:\|[ \t]*:?-{3,}:?[ \t]*)+\|?(?:\n|\r\n?)/.source;e.languages.markdown=e.languages.extend("markup",{}),e.languages.insertBefore("markdown","prolog",{"front-matter-block":{pattern:/(^(?:\s*[\r\n])?)---(?!.)[\s\S]*?[\r\n]---(?!.)/,lookbehind:!0,greedy:!0,inside:{punctuation:/^---|---$/,"front-matter":{pattern:/\S+(?:\s+\S+)*/,alias:["yaml","language-yaml"],inside:e.languages.yaml}}},blockquote:{pattern:/^>(?:[\t ]*>)*/m,alias:"punctuation"},table:{pattern:RegExp("^"+a+o+"(?:"+a+")*","m"),inside:{"table-data-rows":{pattern:RegExp("^("+a+o+")(?:"+a+")*$"),lookbehind:!0,inside:{"table-data":{pattern:RegExp(r),inside:e.languages.markdown},punctuation:/\|/}},"table-line":{pattern:RegExp("^("+a+")"+o+"$"),lookbehind:!0,inside:{punctuation:/\||:?-{3,}:?/}},"table-header-row":{pattern:RegExp("^"+a+"$"),inside:{"table-header":{pattern:RegExp(r),alias:"important",inside:e.languages.markdown},punctuation:/\|/}}}},code:[{pattern:/((?:^|\n)[ \t]*\n|(?:^|\r\n?)[ \t]*\r\n?)(?: {4}|\t).+(?:(?:\n|\r\n?)(?: {4}|\t).+)*/,lookbehind:!0,alias:"keyword"},{pattern:/^```[\s\S]*?^```$/m,greedy:!0,inside:{"code-block":{pattern:/^(```.*(?:\n|\r\n?))[\s\S]+?(?=(?:\n|\r\n?)^```$)/m,lookbehind:!0},"code-language":{pattern:/^(```).+/,lookbehind:!0},punctuation:/```/}}],title:[{pattern:/\S.*(?:\n|\r\n?)(?:==+|--+)(?=[ \t]*$)/m,alias:"important",inside:{punctuation:/==+$|--+$/}},{pattern:/(^\s*)#.+/m,lookbehind:!0,alias:"important",inside:{punctuation:/^#+|#+$/}}],hr:{pattern:/(^\s*)([*-])(?:[\t ]*\2){2,}(?=\s*$)/m,lookbehind:!0,alias:"punctuation"},list:{pattern:/(^\s*)(?:[*+-]|\d+\.)(?=[\t ].)/m,lookbehind:!0,alias:"punctuation"},"url-reference":{pattern:/!?\[[^\]]+\]:[\t ]+(?:\S+|<(?:\\.|[^>\\])+>)(?:[\t ]+(?:"(?:\\.|[^"\\])*"|'(?:\\.|[^'\\])*'|\((?:\\.|[^)\\])*\)))?/,inside:{variable:{pattern:/^(!?\[)[^\]]+/,lookbehind:!0},string:/(?:"(?:\\.|[^"\\])*"|'(?:\\.|[^'\\])*'|\((?:\\.|[^)\\])*\))$/,punctuation:/^[\[\]!:]|[<>]/},alias:"url"},bold:{pattern:n(/\b__(?:(?!_)|_(?:(?!_))+_)+__\b|\*\*(?:(?!\*)|\*(?:(?!\*))+\*)+\*\*/.source),lookbehind:!0,greedy:!0,inside:{content:{pattern:/(^..)[\s\S]+(?=..$)/,lookbehind:!0,inside:{}},punctuation:/\*\*|__/}},italic:{pattern:n(/\b_(?:(?!_)|__(?:(?!_))+__)+_\b|\*(?:(?!\*)|\*\*(?:(?!\*))+\*\*)+\*/.source),lookbehind:!0,greedy:!0,inside:{content:{pattern:/(^.)[\s\S]+(?=.$)/,lookbehind:!0,inside:{}},punctuation:/[*_]/}},strike:{pattern:n(/(~~?)(?:(?!~))+\2/.source),lookbehind:!0,greedy:!0,inside:{content:{pattern:/(^~~?)[\s\S]+(?=\1$)/,lookbehind:!0,inside:{}},punctuation:/~~?/}},"code-snippet":{pattern:/(^|[^\\`])(?:``[^`\r\n]+(?:`[^`\r\n]+)*``(?!`)|`[^`\r\n]+`(?!`))/,lookbehind:!0,greedy:!0,alias:["code","keyword"]},url:{pattern:n(/!?\[(?:(?!\]))+\](?:\([^\s)]+(?:[\t ]+"(?:\\.|[^"\\])*")?\)|[ \t]?\[(?:(?!\]))+\])/.source),lookbehind:!0,greedy:!0,inside:{operator:/^!/,content:{pattern:/(^\[)[^\]]+(?=\])/,lookbehind:!0,inside:{}},variable:{pattern:/(^\][ \t]?\[)[^\]]+(?=\]$)/,lookbehind:!0},url:{pattern:/(^\]\()[^\s)]+/,lookbehind:!0},string:{pattern:/(^[ \t]+)"(?:\\.|[^"\\])*"(?=\)$)/,lookbehind:!0}}}}),["url","bold","italic","strike"].forEach((function(t){["url","bold","italic","strike","code-snippet"].forEach((function(n){t!==n&&(e.languages.markdown[t].inside.content.inside[n]=e.languages.markdown[n])}))})),e.hooks.add("after-tokenize",(function(e){"markdown"!==e.language&&"md"!==e.language||function e(t){if(t&&"string"!=typeof t)for(var n=0,r=t.length;n",quot:'"'},c=String.fromCodePoint||String.fromCharCode;e.languages.md=e.languages.markdown}(a),a.languages.graphql={comment:/#.*/,description:{pattern:/(?:"""(?:[^"]|(?!""")")*"""|"(?:\\.|[^\\"\r\n])*")(?=\s*[a-z_])/i,greedy:!0,alias:"string",inside:{"language-markdown":{pattern:/(^"(?:"")?)(?!\1)[\s\S]+(?=\1$)/,lookbehind:!0,inside:a.languages.markdown}}},string:{pattern:/"""(?:[^"]|(?!""")")*"""|"(?:\\.|[^\\"\r\n])*"/,greedy:!0},number:/(?:\B-|\b)\d+(?:\.\d+)?(?:e[+-]?\d+)?\b/i,boolean:/\b(?:false|true)\b/,variable:/\$[a-z_]\w*/i,directive:{pattern:/@[a-z_]\w*/i,alias:"function"},"attr-name":{pattern:/\b[a-z_]\w*(?=\s*(?:\((?:[^()"]|"(?:\\.|[^\\"\r\n])*")*\))?:)/i,greedy:!0},"atom-input":{pattern:/\b[A-Z]\w*Input\b/,alias:"class-name"},scalar:/\b(?:Boolean|Float|ID|Int|String)\b/,constant:/\b[A-Z][A-Z_\d]*\b/,"class-name":{pattern:/(\b(?:enum|implements|interface|on|scalar|type|union)\s+|&\s*|:\s*|\[)[A-Z_]\w*/,lookbehind:!0},fragment:{pattern:/(\bfragment\s+|\.{3}\s*(?!on\b))[a-zA-Z_]\w*/,lookbehind:!0,alias:"function"},"definition-mutation":{pattern:/(\bmutation\s+)[a-zA-Z_]\w*/,lookbehind:!0,alias:"function"},"definition-query":{pattern:/(\bquery\s+)[a-zA-Z_]\w*/,lookbehind:!0,alias:"function"},keyword:/\b(?:directive|enum|extend|fragment|implements|input|interface|mutation|on|query|repeatable|scalar|schema|subscription|type|union)\b/,operator:/[!=|&]|\.{3}/,"property-query":/\w+(?=\s*\()/,object:/\w+(?=\s*\{)/,punctuation:/[!(){}\[\]:=,]/,property:/\w+/},a.hooks.add("after-tokenize",(function(e){if("graphql"===e.language)for(var t=e.tokens.filter((function(e){return"string"!=typeof e&&"comment"!==e.type&&"scalar"!==e.type})),n=0;n0)){var s=p(/^\{$/,/^\}$/);if(-1===s)continue;for(var c=n;c=0&&f(l,"variable-input")}}}}function u(e){return t[n+e]}function d(e,t){t=t||0;for(var n=0;n?|<|>)?|>[>=]?|\b(?:AND|BETWEEN|DIV|ILIKE|IN|IS|LIKE|NOT|OR|REGEXP|RLIKE|SOUNDS LIKE|XOR)\b/i,punctuation:/[;[\]()`,.]/},function(e){var t=e.languages.javascript["template-string"],n=t.pattern.source,r=t.inside.interpolation,a=r.inside["interpolation-punctuation"],o=r.pattern.source;function i(t,r){if(e.languages[t])return{pattern:RegExp("((?:"+r+")\\s*)"+n),lookbehind:!0,greedy:!0,inside:{"template-punctuation":{pattern:/^`|`$/,alias:"string"},"embedded-code":{pattern:/[\s\S]+/,alias:t}}}}function s(e,t){return"___"+t.toUpperCase()+"_"+e+"___"}function c(t,n,r){var a={code:t,grammar:n,language:r};return e.hooks.run("before-tokenize",a),a.tokens=e.tokenize(a.code,a.grammar),e.hooks.run("after-tokenize",a),a.tokens}function l(t){var n={};n["interpolation-punctuation"]=a;var o=e.tokenize(t,n);if(3===o.length){var i=[1,1];i.push.apply(i,c(o[1],e.languages.javascript,"javascript")),o.splice.apply(o,i)}return new e.Token("interpolation",o,r.alias,t)}function u(t,n,r){var a=e.tokenize(t,{interpolation:{pattern:RegExp(o),lookbehind:!0}}),i=0,u={},d=c(a.map((function(e){if("string"==typeof e)return e;for(var n,a=e.content;-1!==t.indexOf(n=s(i++,r)););return u[n]=a,n})).join(""),n,r),p=Object.keys(u);return i=0,function e(t){for(var n=0;n=p.length)return;var r=t[n];if("string"==typeof r||"string"==typeof r.content){var a=p[i],o="string"==typeof r?r:r.content,s=o.indexOf(a);if(-1!==s){++i;var c=o.substring(0,s),d=l(u[a]),f=o.substring(s+a.length),h=[];if(c&&h.push(c),h.push(d),f){var m=[f];e(m),h.push.apply(h,m)}"string"==typeof r?(t.splice.apply(t,[n,1].concat(h)),n+=h.length-1):r.content=h}}else{var g=r.content;Array.isArray(g)?e(g):e([g])}}}(d),new e.Token(r,d,"language-"+r,t)}e.languages.javascript["template-string"]=[i("css",/\b(?:styled(?:\([^)]*\))?(?:\s*\.\s*\w+(?:\([^)]*\))*)*|css(?:\s*\.\s*(?:global|resolve))?|createGlobalStyle|keyframes)/.source),i("html",/\bhtml|\.\s*(?:inner|outer)HTML\s*\+?=/.source),i("svg",/\bsvg/.source),i("markdown",/\b(?:markdown|md)/.source),i("graphql",/\b(?:gql|graphql(?:\s*\.\s*experimental)?)/.source),i("sql",/\bsql/.source),t].filter(Boolean);var d={javascript:!0,js:!0,typescript:!0,ts:!0,jsx:!0,tsx:!0};function p(e){return"string"==typeof e?e:Array.isArray(e)?e.map(p).join(""):p(e.content)}e.hooks.add("after-tokenize",(function(t){t.language in d&&function t(n){for(var r=0,a=n.length;r]|<(?:[^<>]|<[^<>]*>)*>)*>)?/,lookbehind:!0,greedy:!0,inside:null},builtin:/\b(?:Array|Function|Promise|any|boolean|console|never|number|string|symbol|unknown)\b/}),e.languages.typescript.keyword.push(/\b(?:abstract|declare|is|keyof|readonly|require)\b/,/\b(?:asserts|infer|interface|module|namespace|type)\b(?=\s*(?:[{_$a-zA-Z\xA0-\uFFFF]|$))/,/\btype\b(?=\s*(?:[\{*]|$))/),delete e.languages.typescript.parameter,delete e.languages.typescript["literal-property"];var t=e.languages.extend("typescript",{});delete t["class-name"],e.languages.typescript["class-name"].inside=t,e.languages.insertBefore("typescript","function",{decorator:{pattern:/@[$\w\xA0-\uFFFF]+/,inside:{at:{pattern:/^@/,alias:"operator"},function:/^[\s\S]+/}},"generic-function":{pattern:/#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*\s*<(?:[^<>]|<(?:[^<>]|<[^<>]*>)*>)*>(?=\s*\()/,greedy:!0,inside:{function:/^#?(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*/,generic:{pattern:/<[\s\S]+/,alias:"class-name",inside:t}}}}),e.languages.ts=e.languages.typescript}(a),function(e){function t(e,t){return RegExp(e.replace(//g,(function(){return/(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*/.source})),t)}e.languages.insertBefore("javascript","function-variable",{"method-variable":{pattern:RegExp("(\\.\\s*)"+e.languages.javascript["function-variable"].pattern.source),lookbehind:!0,alias:["function-variable","method","function","property-access"]}}),e.languages.insertBefore("javascript","function",{method:{pattern:RegExp("(\\.\\s*)"+e.languages.javascript.function.source),lookbehind:!0,alias:["function","property-access"]}}),e.languages.insertBefore("javascript","constant",{"known-class-name":[{pattern:/\b(?:(?:Float(?:32|64)|(?:Int|Uint)(?:8|16|32)|Uint8Clamped)?Array|ArrayBuffer|BigInt|Boolean|DataView|Date|Error|Function|Intl|JSON|(?:Weak)?(?:Map|Set)|Math|Number|Object|Promise|Proxy|Reflect|RegExp|String|Symbol|WebAssembly)\b/,alias:"class-name"},{pattern:/\b(?:[A-Z]\w*)Error\b/,alias:"class-name"}]}),e.languages.insertBefore("javascript","keyword",{imports:{pattern:t(/(\bimport\b\s*)(?:(?:\s*,\s*(?:\*\s*as\s+|\{[^{}]*\}))?|\*\s*as\s+|\{[^{}]*\})(?=\s*\bfrom\b)/.source),lookbehind:!0,inside:e.languages.javascript},exports:{pattern:t(/(\bexport\b\s*)(?:\*(?:\s*as\s+)?(?=\s*\bfrom\b)|\{[^{}]*\})/.source),lookbehind:!0,inside:e.languages.javascript}}),e.languages.javascript.keyword.unshift({pattern:/\b(?:as|default|export|from|import)\b/,alias:"module"},{pattern:/\b(?:await|break|catch|continue|do|else|finally|for|if|return|switch|throw|try|while|yield)\b/,alias:"control-flow"},{pattern:/\bnull\b/,alias:["null","nil"]},{pattern:/\bundefined\b/,alias:"nil"}),e.languages.insertBefore("javascript","operator",{spread:{pattern:/\.{3}/,alias:"operator"},arrow:{pattern:/=>/,alias:"operator"}}),e.languages.insertBefore("javascript","punctuation",{"property-access":{pattern:t(/(\.\s*)#?/.source),lookbehind:!0},"maybe-class-name":{pattern:/(^|[^$\w\xA0-\uFFFF])[A-Z][$\w\xA0-\uFFFF]+/,lookbehind:!0},dom:{pattern:/\b(?:document|(?:local|session)Storage|location|navigator|performance|window)\b/,alias:"variable"},console:{pattern:/\bconsole(?=\s*\.)/,alias:"class-name"}});for(var n=["function","function-variable","method","method-variable","property-access"],r=0;r*\.{3}(?:[^{}]|)*\})/.source;function o(e,t){return e=e.replace(//g,(function(){return n})).replace(//g,(function(){return r})).replace(//g,(function(){return a})),RegExp(e,t)}a=o(a).source,e.languages.jsx=e.languages.extend("markup",t),e.languages.jsx.tag.pattern=o(/<\/?(?:[\w.:-]+(?:+(?:[\w.:$-]+(?:=(?:"(?:\\[\s\S]|[^\\"])*"|'(?:\\[\s\S]|[^\\'])*'|[^\s{'"/>=]+|))?|))**\/?)?>/.source),e.languages.jsx.tag.inside.tag.pattern=/^<\/?[^\s>\/]*/,e.languages.jsx.tag.inside["attr-value"].pattern=/=(?!\{)(?:"(?:\\[\s\S]|[^\\"])*"|'(?:\\[\s\S]|[^\\'])*'|[^\s'">]+)/,e.languages.jsx.tag.inside.tag.inside["class-name"]=/^[A-Z]\w*(?:\.[A-Z]\w*)*$/,e.languages.jsx.tag.inside.comment=t.comment,e.languages.insertBefore("inside","attr-name",{spread:{pattern:o(//.source),inside:e.languages.jsx}},e.languages.jsx.tag),e.languages.insertBefore("inside","special-attr",{script:{pattern:o(/=/.source),alias:"language-javascript",inside:{"script-punctuation":{pattern:/^=(?=\{)/,alias:"punctuation"},rest:e.languages.jsx}}},e.languages.jsx.tag);var i=function(e){return e?"string"==typeof e?e:"string"==typeof e.content?e.content:e.content.map(i).join(""):""},s=function(t){for(var n=[],r=0;r0&&n[n.length-1].tagName===i(a.content[0].content[1])&&n.pop():"/>"===a.content[a.content.length-1].content||n.push({tagName:i(a.content[0].content[1]),openedBraces:0}):n.length>0&&"punctuation"===a.type&&"{"===a.content?n[n.length-1].openedBraces++:n.length>0&&n[n.length-1].openedBraces>0&&"punctuation"===a.type&&"}"===a.content?n[n.length-1].openedBraces--:o=!0),(o||"string"==typeof a)&&n.length>0&&0===n[n.length-1].openedBraces){var c=i(a);r0&&("string"==typeof t[r-1]||"plain-text"===t[r-1].type)&&(c=i(t[r-1])+c,t.splice(r-1,1),r--),t[r]=new e.Token("plain-text",c,null,c)}a.content&&"string"!=typeof a.content&&s(a.content)}};e.hooks.add("after-tokenize",(function(e){"jsx"!==e.language&&"tsx"!==e.language||s(e.tokens)}))}(a),function(e){e.languages.diff={coord:[/^(?:\*{3}|-{3}|\+{3}).*$/m,/^@@.*@@$/m,/^\d.*$/m]};var t={"deleted-sign":"-","deleted-arrow":"<","inserted-sign":"+","inserted-arrow":">",unchanged:" ",diff:"!"};Object.keys(t).forEach((function(n){var r=t[n],a=[];/^\w+$/.test(n)||a.push(/\w+/.exec(n)[0]),"diff"===n&&a.push("bold"),e.languages.diff[n]={pattern:RegExp("^(?:["+r+"].*(?:\r\n?|\n|(?![\\s\\S])))+","m"),alias:a,inside:{line:{pattern:/(.)(?=[\s\S]).*(?:\r\n?|\n)?/,lookbehind:!0},prefix:{pattern:/[\s\S]/,alias:/\w+/.exec(n)[0]}}}})),Object.defineProperty(e.languages.diff,"PREFIXES",{value:t})}(a),a.languages.git={comment:/^#.*/m,deleted:/^[-\u2013].*/m,inserted:/^\+.*/m,string:/("|')(?:\\.|(?!\1)[^\\\r\n])*\1/,command:{pattern:/^.*\$ git .*$/m,inside:{parameter:/\s--?\w+/}},coord:/^@@.*@@$/m,"commit-sha1":/^commit \w{40}$/m},a.languages.go=a.languages.extend("clike",{string:{pattern:/(^|[^\\])"(?:\\.|[^"\\\r\n])*"|`[^`]*`/,lookbehind:!0,greedy:!0},keyword:/\b(?:break|case|chan|const|continue|default|defer|else|fallthrough|for|func|go(?:to)?|if|import|interface|map|package|range|return|select|struct|switch|type|var)\b/,boolean:/\b(?:_|false|iota|nil|true)\b/,number:[/\b0(?:b[01_]+|o[0-7_]+)i?\b/i,/\b0x(?:[a-f\d_]+(?:\.[a-f\d_]*)?|\.[a-f\d_]+)(?:p[+-]?\d+(?:_\d+)*)?i?(?!\w)/i,/(?:\b\d[\d_]*(?:\.[\d_]*)?|\B\.\d[\d_]*)(?:e[+-]?[\d_]+)?i?(?!\w)/i],operator:/[*\/%^!=]=?|\+[=+]?|-[=-]?|\|[=|]?|&(?:=|&|\^=?)?|>(?:>=?|=)?|<(?:<=?|=|-)?|:=|\.\.\./,builtin:/\b(?:append|bool|byte|cap|close|complex|complex(?:64|128)|copy|delete|error|float(?:32|64)|u?int(?:8|16|32|64)?|imag|len|make|new|panic|print(?:ln)?|real|recover|rune|string|uintptr)\b/}),a.languages.insertBefore("go","string",{char:{pattern:/'(?:\\.|[^'\\\r\n]){0,10}'/,greedy:!0}}),delete a.languages.go["class-name"],function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,r,a,o){if(n.language===r){var i=n.tokenStack=[];n.code=n.code.replace(a,(function(e){if("function"==typeof o&&!o(e))return e;for(var a,s=i.length;-1!==n.code.indexOf(a=t(r,s));)++s;return i[s]=e,a})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,r){if(n.language===r&&n.tokenStack){n.grammar=e.languages[r];var a=0,o=Object.keys(n.tokenStack);!function i(s){for(var c=0;c=o.length);c++){var l=s[c];if("string"==typeof l||l.content&&"string"==typeof l.content){var u=o[a],d=n.tokenStack[u],p="string"==typeof l?l:l.content,f=t(r,u),h=p.indexOf(f);if(h>-1){++a;var m=p.substring(0,h),g=new e.Token(r,e.tokenize(d,n.grammar),"language-"+r,d),b=p.substring(h+f.length),y=[];m&&y.push.apply(y,i([m])),y.push(g),b&&y.push.apply(y,i([b])),"string"==typeof l?s.splice.apply(s,[c,1].concat(y)):l.content=y}}else l.content&&i(l.content)}return s}(n.tokens)}}}})}(a),function(e){e.languages.handlebars={comment:/\{\{![\s\S]*?\}\}/,delimiter:{pattern:/^\{\{\{?|\}\}\}?$/,alias:"punctuation"},string:/(["'])(?:\\.|(?!\1)[^\\\r\n])*\1/,number:/\b0x[\dA-Fa-f]+\b|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:[Ee][+-]?\d+)?/,boolean:/\b(?:false|true)\b/,block:{pattern:/^(\s*(?:~\s*)?)[#\/]\S+?(?=\s*(?:~\s*)?$|\s)/,lookbehind:!0,alias:"keyword"},brackets:{pattern:/\[[^\]]+\]/,inside:{punctuation:/\[|\]/,variable:/[\s\S]+/}},punctuation:/[!"#%&':()*+,.\/;<=>@\[\\\]^`{|}~]/,variable:/[^!"#%&'()*+,\/;<=>@\[\\\]^`{|}~\s]+/},e.hooks.add("before-tokenize",(function(t){e.languages["markup-templating"].buildPlaceholders(t,"handlebars",/\{\{\{[\s\S]+?\}\}\}|\{\{[\s\S]+?\}\}/g)})),e.hooks.add("after-tokenize",(function(t){e.languages["markup-templating"].tokenizePlaceholders(t,"handlebars")})),e.languages.hbs=e.languages.handlebars}(a),a.languages.json={property:{pattern:/(^|[^\\])"(?:\\.|[^\\"\r\n])*"(?=\s*:)/,lookbehind:!0,greedy:!0},string:{pattern:/(^|[^\\])"(?:\\.|[^\\"\r\n])*"(?!\s*:)/,lookbehind:!0,greedy:!0},comment:{pattern:/\/\/.*|\/\*[\s\S]*?(?:\*\/|$)/,greedy:!0},number:/-?\b\d+(?:\.\d+)?(?:e[+-]?\d+)?\b/i,punctuation:/[{}[\],]/,operator:/:/,boolean:/\b(?:false|true)\b/,null:{pattern:/\bnull\b/,alias:"keyword"}},a.languages.webmanifest=a.languages.json,a.languages.less=a.languages.extend("css",{comment:[/\/\*[\s\S]*?\*\//,{pattern:/(^|[^\\])\/\/.*/,lookbehind:!0}],atrule:{pattern:/@[\w-](?:\((?:[^(){}]|\([^(){}]*\))*\)|[^(){};\s]|\s+(?!\s))*?(?=\s*\{)/,inside:{punctuation:/[:()]/}},selector:{pattern:/(?:@\{[\w-]+\}|[^{};\s@])(?:@\{[\w-]+\}|\((?:[^(){}]|\([^(){}]*\))*\)|[^(){};@\s]|\s+(?!\s))*?(?=\s*\{)/,inside:{variable:/@+[\w-]+/}},property:/(?:@\{[\w-]+\}|[\w-])+(?:\+_?)?(?=\s*:)/,operator:/[+\-*\/]/}),a.languages.insertBefore("less","property",{variable:[{pattern:/@[\w-]+\s*:/,inside:{punctuation:/:/}},/@@?[\w-]+/],"mixin-usage":{pattern:/([{;]\s*)[.#](?!\d)[\w-].*?(?=[(;])/,lookbehind:!0,alias:"function"}}),a.languages.makefile={comment:{pattern:/(^|[^\\])#(?:\\(?:\r\n|[\s\S])|[^\\\r\n])*/,lookbehind:!0},string:{pattern:/(["'])(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/,greedy:!0},"builtin-target":{pattern:/\.[A-Z][^:#=\s]+(?=\s*:(?!=))/,alias:"builtin"},target:{pattern:/^(?:[^:=\s]|[ \t]+(?![\s:]))+(?=\s*:(?!=))/m,alias:"symbol",inside:{variable:/\$+(?:(?!\$)[^(){}:#=\s]+|(?=[({]))/}},variable:/\$+(?:(?!\$)[^(){}:#=\s]+|\([@*%<^+?][DF]\)|(?=[({]))/,keyword:/-include\b|\b(?:define|else|endef|endif|export|ifn?def|ifn?eq|include|override|private|sinclude|undefine|unexport|vpath)\b/,function:{pattern:/(\()(?:abspath|addsuffix|and|basename|call|dir|error|eval|file|filter(?:-out)?|findstring|firstword|flavor|foreach|guile|if|info|join|lastword|load|notdir|or|origin|patsubst|realpath|shell|sort|strip|subst|suffix|value|warning|wildcard|word(?:list|s)?)(?=[ \t])/,lookbehind:!0},operator:/(?:::|[?:+!])?=|[|@]/,punctuation:/[:;(){}]/},a.languages.objectivec=a.languages.extend("c",{string:{pattern:/@?"(?:\\(?:\r\n|[\s\S])|[^"\\\r\n])*"/,greedy:!0},keyword:/\b(?:asm|auto|break|case|char|const|continue|default|do|double|else|enum|extern|float|for|goto|if|in|inline|int|long|register|return|self|short|signed|sizeof|static|struct|super|switch|typedef|typeof|union|unsigned|void|volatile|while)\b|(?:@interface|@end|@implementation|@protocol|@class|@public|@protected|@private|@property|@try|@catch|@finally|@throw|@synthesize|@dynamic|@selector)\b/,operator:/-[->]?|\+\+?|!=?|<>?=?|==?|&&?|\|\|?|[~^%?*\/@]/}),delete a.languages.objectivec["class-name"],a.languages.objc=a.languages.objectivec,a.languages.ocaml={comment:{pattern:/\(\*[\s\S]*?\*\)/,greedy:!0},char:{pattern:/'(?:[^\\\r\n']|\\(?:.|[ox]?[0-9a-f]{1,3}))'/i,greedy:!0},string:[{pattern:/"(?:\\(?:[\s\S]|\r\n)|[^\\\r\n"])*"/,greedy:!0},{pattern:/\{([a-z_]*)\|[\s\S]*?\|\1\}/,greedy:!0}],number:[/\b(?:0b[01][01_]*|0o[0-7][0-7_]*)\b/i,/\b0x[a-f0-9][a-f0-9_]*(?:\.[a-f0-9_]*)?(?:p[+-]?\d[\d_]*)?(?!\w)/i,/\b\d[\d_]*(?:\.[\d_]*)?(?:e[+-]?\d[\d_]*)?(?!\w)/i],directive:{pattern:/\B#\w+/,alias:"property"},label:{pattern:/\B~\w+/,alias:"property"},"type-variable":{pattern:/\B'\w+/,alias:"function"},variant:{pattern:/`\w+/,alias:"symbol"},keyword:/\b(?:as|assert|begin|class|constraint|do|done|downto|else|end|exception|external|for|fun|function|functor|if|in|include|inherit|initializer|lazy|let|match|method|module|mutable|new|nonrec|object|of|open|private|rec|sig|struct|then|to|try|type|val|value|virtual|when|where|while|with)\b/,boolean:/\b(?:false|true)\b/,"operator-like-punctuation":{pattern:/\[[<>|]|[>|]\]|\{<|>\}/,alias:"punctuation"},operator:/\.[.~]|:[=>]|[=<>@^|&+\-*\/$%!?~][!$%&*+\-.\/:<=>?@^|~]*|\b(?:and|asr|land|lor|lsl|lsr|lxor|mod|or)\b/,punctuation:/;;|::|[(){}\[\].,:;#]|\b_\b/},a.languages.python={comment:{pattern:/(^|[^\\])#.*/,lookbehind:!0,greedy:!0},"string-interpolation":{pattern:/(?:f|fr|rf)(?:("""|''')[\s\S]*?\1|("|')(?:\\.|(?!\2)[^\\\r\n])*\2)/i,greedy:!0,inside:{interpolation:{pattern:/((?:^|[^{])(?:\{\{)*)\{(?!\{)(?:[^{}]|\{(?!\{)(?:[^{}]|\{(?!\{)(?:[^{}])+\})+\})+\}/,lookbehind:!0,inside:{"format-spec":{pattern:/(:)[^:(){}]+(?=\}$)/,lookbehind:!0},"conversion-option":{pattern:/![sra](?=[:}]$)/,alias:"punctuation"},rest:null}},string:/[\s\S]+/}},"triple-quoted-string":{pattern:/(?:[rub]|br|rb)?("""|''')[\s\S]*?\1/i,greedy:!0,alias:"string"},string:{pattern:/(?:[rub]|br|rb)?("|')(?:\\.|(?!\1)[^\\\r\n])*\1/i,greedy:!0},function:{pattern:/((?:^|\s)def[ \t]+)[a-zA-Z_]\w*(?=\s*\()/g,lookbehind:!0},"class-name":{pattern:/(\bclass\s+)\w+/i,lookbehind:!0},decorator:{pattern:/(^[\t ]*)@\w+(?:\.\w+)*/m,lookbehind:!0,alias:["annotation","punctuation"],inside:{punctuation:/\./}},keyword:/\b(?:_(?=\s*:)|and|as|assert|async|await|break|case|class|continue|def|del|elif|else|except|exec|finally|for|from|global|if|import|in|is|lambda|match|nonlocal|not|or|pass|print|raise|return|try|while|with|yield)\b/,builtin:/\b(?:__import__|abs|all|any|apply|ascii|basestring|bin|bool|buffer|bytearray|bytes|callable|chr|classmethod|cmp|coerce|compile|complex|delattr|dict|dir|divmod|enumerate|eval|execfile|file|filter|float|format|frozenset|getattr|globals|hasattr|hash|help|hex|id|input|int|intern|isinstance|issubclass|iter|len|list|locals|long|map|max|memoryview|min|next|object|oct|open|ord|pow|property|range|raw_input|reduce|reload|repr|reversed|round|set|setattr|slice|sorted|staticmethod|str|sum|super|tuple|type|unichr|unicode|vars|xrange|zip)\b/,boolean:/\b(?:False|None|True)\b/,number:/\b0(?:b(?:_?[01])+|o(?:_?[0-7])+|x(?:_?[a-f0-9])+)\b|(?:\b\d+(?:_\d+)*(?:\.(?:\d+(?:_\d+)*)?)?|\B\.\d+(?:_\d+)*)(?:e[+-]?\d+(?:_\d+)*)?j?(?!\w)/i,operator:/[-+%=]=?|!=|:=|\*\*?=?|\/\/?=?|<[<=>]?|>[=>]?|[&|^~]/,punctuation:/[{}[\];(),.:]/},a.languages.python["string-interpolation"].inside.interpolation.inside.rest=a.languages.python,a.languages.py=a.languages.python,a.languages.reason=a.languages.extend("clike",{string:{pattern:/"(?:\\(?:\r\n|[\s\S])|[^\\\r\n"])*"/,greedy:!0},"class-name":/\b[A-Z]\w*/,keyword:/\b(?:and|as|assert|begin|class|constraint|do|done|downto|else|end|exception|external|for|fun|function|functor|if|in|include|inherit|initializer|lazy|let|method|module|mutable|new|nonrec|object|of|open|or|private|rec|sig|struct|switch|then|to|try|type|val|virtual|when|while|with)\b/,operator:/\.{3}|:[:=]|\|>|->|=(?:==?|>)?|<=?|>=?|[|^?'#!~`]|[+\-*\/]\.?|\b(?:asr|land|lor|lsl|lsr|lxor|mod)\b/}),a.languages.insertBefore("reason","class-name",{char:{pattern:/'(?:\\x[\da-f]{2}|\\o[0-3][0-7][0-7]|\\\d{3}|\\.|[^'\\\r\n])'/,greedy:!0},constructor:/\b[A-Z]\w*\b(?!\s*\.)/,label:{pattern:/\b[a-z]\w*(?=::)/,alias:"symbol"}}),delete a.languages.reason.function,function(e){e.languages.sass=e.languages.extend("css",{comment:{pattern:/^([ \t]*)\/[\/*].*(?:(?:\r?\n|\r)\1[ \t].+)*/m,lookbehind:!0,greedy:!0}}),e.languages.insertBefore("sass","atrule",{"atrule-line":{pattern:/^(?:[ \t]*)[@+=].+/m,greedy:!0,inside:{atrule:/(?:@[\w-]+|[+=])/}}}),delete e.languages.sass.atrule;var t=/\$[-\w]+|#\{\$[-\w]+\}/,n=[/[+*\/%]|[=!]=|<=?|>=?|\b(?:and|not|or)\b/,{pattern:/(\s)-(?=\s)/,lookbehind:!0}];e.languages.insertBefore("sass","property",{"variable-line":{pattern:/^[ \t]*\$.+/m,greedy:!0,inside:{punctuation:/:/,variable:t,operator:n}},"property-line":{pattern:/^[ \t]*(?:[^:\s]+ *:.*|:[^:\s].*)/m,greedy:!0,inside:{property:[/[^:\s]+(?=\s*:)/,{pattern:/(:)[^:\s]+/,lookbehind:!0}],punctuation:/:/,variable:t,operator:n,important:e.languages.sass.important}}}),delete e.languages.sass.property,delete e.languages.sass.important,e.languages.insertBefore("sass","punctuation",{selector:{pattern:/^([ \t]*)\S(?:,[^,\r\n]+|[^,\r\n]*)(?:,[^,\r\n]+)*(?:,(?:\r?\n|\r)\1[ \t]+\S(?:,[^,\r\n]+|[^,\r\n]*)(?:,[^,\r\n]+)*)*/m,lookbehind:!0,greedy:!0}})}(a),a.languages.scss=a.languages.extend("css",{comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|\/\/.*)/,lookbehind:!0},atrule:{pattern:/@[\w-](?:\([^()]+\)|[^()\s]|\s+(?!\s))*?(?=\s+[{;])/,inside:{rule:/@[\w-]+/}},url:/(?:[-a-z]+-)?url(?=\()/i,selector:{pattern:/(?=\S)[^@;{}()]?(?:[^@;{}()\s]|\s+(?!\s)|#\{\$[-\w]+\})+(?=\s*\{(?:\}|\s|[^}][^:{}]*[:{][^}]))/,inside:{parent:{pattern:/&/,alias:"important"},placeholder:/%[-\w]+/,variable:/\$[-\w]+|#\{\$[-\w]+\}/}},property:{pattern:/(?:[-\w]|\$[-\w]|#\{\$[-\w]+\})+(?=\s*:)/,inside:{variable:/\$[-\w]+|#\{\$[-\w]+\}/}}}),a.languages.insertBefore("scss","atrule",{keyword:[/@(?:content|debug|each|else(?: if)?|extend|for|forward|function|if|import|include|mixin|return|use|warn|while)\b/i,{pattern:/( )(?:from|through)(?= )/,lookbehind:!0}]}),a.languages.insertBefore("scss","important",{variable:/\$[-\w]+|#\{\$[-\w]+\}/}),a.languages.insertBefore("scss","function",{"module-modifier":{pattern:/\b(?:as|hide|show|with)\b/i,alias:"keyword"},placeholder:{pattern:/%[-\w]+/,alias:"selector"},statement:{pattern:/\B!(?:default|optional)\b/i,alias:"keyword"},boolean:/\b(?:false|true)\b/,null:{pattern:/\bnull\b/,alias:"keyword"},operator:{pattern:/(\s)(?:[-+*\/%]|[=!]=|<=?|>=?|and|not|or)(?=\s)/,lookbehind:!0}}),a.languages.scss.atrule.inside.rest=a.languages.scss,function(e){var t={pattern:/(\b\d+)(?:%|[a-z]+)/,lookbehind:!0},n={pattern:/(^|[^\w.-])-?(?:\d+(?:\.\d+)?|\.\d+)/,lookbehind:!0},r={comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|\/\/.*)/,lookbehind:!0},url:{pattern:/\burl\((["']?).*?\1\)/i,greedy:!0},string:{pattern:/("|')(?:(?!\1)[^\\\r\n]|\\(?:\r\n|[\s\S]))*\1/,greedy:!0},interpolation:null,func:null,important:/\B!(?:important|optional)\b/i,keyword:{pattern:/(^|\s+)(?:(?:else|for|if|return|unless)(?=\s|$)|@[\w-]+)/,lookbehind:!0},hexcode:/#[\da-f]{3,6}/i,color:[/\b(?:AliceBlue|AntiqueWhite|Aqua|Aquamarine|Azure|Beige|Bisque|Black|BlanchedAlmond|Blue|BlueViolet|Brown|BurlyWood|CadetBlue|Chartreuse|Chocolate|Coral|CornflowerBlue|Cornsilk|Crimson|Cyan|DarkBlue|DarkCyan|DarkGoldenRod|DarkGr[ae]y|DarkGreen|DarkKhaki|DarkMagenta|DarkOliveGreen|DarkOrange|DarkOrchid|DarkRed|DarkSalmon|DarkSeaGreen|DarkSlateBlue|DarkSlateGr[ae]y|DarkTurquoise|DarkViolet|DeepPink|DeepSkyBlue|DimGr[ae]y|DodgerBlue|FireBrick|FloralWhite|ForestGreen|Fuchsia|Gainsboro|GhostWhite|Gold|GoldenRod|Gr[ae]y|Green|GreenYellow|HoneyDew|HotPink|IndianRed|Indigo|Ivory|Khaki|Lavender|LavenderBlush|LawnGreen|LemonChiffon|LightBlue|LightCoral|LightCyan|LightGoldenRodYellow|LightGr[ae]y|LightGreen|LightPink|LightSalmon|LightSeaGreen|LightSkyBlue|LightSlateGr[ae]y|LightSteelBlue|LightYellow|Lime|LimeGreen|Linen|Magenta|Maroon|MediumAquaMarine|MediumBlue|MediumOrchid|MediumPurple|MediumSeaGreen|MediumSlateBlue|MediumSpringGreen|MediumTurquoise|MediumVioletRed|MidnightBlue|MintCream|MistyRose|Moccasin|NavajoWhite|Navy|OldLace|Olive|OliveDrab|Orange|OrangeRed|Orchid|PaleGoldenRod|PaleGreen|PaleTurquoise|PaleVioletRed|PapayaWhip|PeachPuff|Peru|Pink|Plum|PowderBlue|Purple|Red|RosyBrown|RoyalBlue|SaddleBrown|Salmon|SandyBrown|SeaGreen|SeaShell|Sienna|Silver|SkyBlue|SlateBlue|SlateGr[ae]y|Snow|SpringGreen|SteelBlue|Tan|Teal|Thistle|Tomato|Transparent|Turquoise|Violet|Wheat|White|WhiteSmoke|Yellow|YellowGreen)\b/i,{pattern:/\b(?:hsl|rgb)\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*\)\B|\b(?:hsl|rgb)a\(\s*\d{1,3}\s*,\s*\d{1,3}%?\s*,\s*\d{1,3}%?\s*,\s*(?:0|0?\.\d+|1)\s*\)\B/i,inside:{unit:t,number:n,function:/[\w-]+(?=\()/,punctuation:/[(),]/}}],entity:/\\[\da-f]{1,8}/i,unit:t,boolean:/\b(?:false|true)\b/,operator:[/~|[+!\/%<>?=]=?|[-:]=|\*[*=]?|\.{2,3}|&&|\|\||\B-\B|\b(?:and|in|is(?: a| defined| not|nt)?|not|or)\b/],number:n,punctuation:/[{}()\[\];:,]/};r.interpolation={pattern:/\{[^\r\n}:]+\}/,alias:"variable",inside:{delimiter:{pattern:/^\{|\}$/,alias:"punctuation"},rest:r}},r.func={pattern:/[\w-]+\([^)]*\).*/,inside:{function:/^[^(]+/,rest:r}},e.languages.stylus={"atrule-declaration":{pattern:/(^[ \t]*)@.+/m,lookbehind:!0,inside:{atrule:/^@[\w-]+/,rest:r}},"variable-declaration":{pattern:/(^[ \t]*)[\w$-]+\s*.?=[ \t]*(?:\{[^{}]*\}|\S.*|$)/m,lookbehind:!0,inside:{variable:/^\S+/,rest:r}},statement:{pattern:/(^[ \t]*)(?:else|for|if|return|unless)[ \t].+/m,lookbehind:!0,inside:{keyword:/^\S+/,rest:r}},"property-declaration":{pattern:/((?:^|\{)([ \t]*))(?:[\w-]|\{[^}\r\n]+\})+(?:\s*:\s*|[ \t]+)(?!\s)[^{\r\n]*(?:;|[^{\r\n,]$(?!(?:\r?\n|\r)(?:\{|\2[ \t])))/m,lookbehind:!0,inside:{property:{pattern:/^[^\s:]+/,inside:{interpolation:r.interpolation}},rest:r}},selector:{pattern:/(^[ \t]*)(?:(?=\S)(?:[^{}\r\n:()]|::?[\w-]+(?:\([^)\r\n]*\)|(?![\w-]))|\{[^}\r\n]+\})+)(?:(?:\r?\n|\r)(?:\1(?:(?=\S)(?:[^{}\r\n:()]|::?[\w-]+(?:\([^)\r\n]*\)|(?![\w-]))|\{[^}\r\n]+\})+)))*(?:,$|\{|(?=(?:\r?\n|\r)(?:\{|\1[ \t])))/m,lookbehind:!0,inside:{interpolation:r.interpolation,comment:r.comment,punctuation:/[{},]/}},func:r.func,string:r.string,comment:{pattern:/(^|[^\\])(?:\/\*[\s\S]*?\*\/|\/\/.*)/,lookbehind:!0,greedy:!0},interpolation:r.interpolation,punctuation:/[{}()\[\];:.]/}}(a),function(e){var t=e.util.clone(e.languages.typescript);e.languages.tsx=e.languages.extend("jsx",t),delete e.languages.tsx.parameter,delete e.languages.tsx["literal-property"];var n=e.languages.tsx.tag;n.pattern=RegExp(/(^|[^\w$]|(?=<\/))/.source+"(?:"+n.pattern.source+")",n.pattern.flags),n.lookbehind=!0}(a),a.languages.wasm={comment:[/\(;[\s\S]*?;\)/,{pattern:/;;.*/,greedy:!0}],string:{pattern:/"(?:\\[\s\S]|[^"\\])*"/,greedy:!0},keyword:[{pattern:/\b(?:align|offset)=/,inside:{operator:/=/}},{pattern:/\b(?:(?:f32|f64|i32|i64)(?:\.(?:abs|add|and|ceil|clz|const|convert_[su]\/i(?:32|64)|copysign|ctz|demote\/f64|div(?:_[su])?|eqz?|extend_[su]\/i32|floor|ge(?:_[su])?|gt(?:_[su])?|le(?:_[su])?|load(?:(?:8|16|32)_[su])?|lt(?:_[su])?|max|min|mul|neg?|nearest|or|popcnt|promote\/f32|reinterpret\/[fi](?:32|64)|rem_[su]|rot[lr]|shl|shr_[su]|sqrt|store(?:8|16|32)?|sub|trunc(?:_[su]\/f(?:32|64))?|wrap\/i64|xor))?|memory\.(?:grow|size))\b/,inside:{punctuation:/\./}},/\b(?:anyfunc|block|br(?:_if|_table)?|call(?:_indirect)?|data|drop|elem|else|end|export|func|get_(?:global|local)|global|if|import|local|loop|memory|module|mut|nop|offset|param|result|return|select|set_(?:global|local)|start|table|tee_local|then|type|unreachable)\b/],variable:/\$[\w!#$%&'*+\-./:<=>?@\\^`|~]+/,number:/[+-]?\b(?:\d(?:_?\d)*(?:\.\d(?:_?\d)*)?(?:[eE][+-]?\d(?:_?\d)*)?|0x[\da-fA-F](?:_?[\da-fA-F])*(?:\.[\da-fA-F](?:_?[\da-fA-D])*)?(?:[pP][+-]?\d(?:_?\d)*)?)\b|\binf\b|\bnan(?::0x[\da-fA-F](?:_?[\da-fA-D])*)?\b/,punctuation:/[()]/};const o=a},7874:()=>{!function(e){var t="\\b(?:BASH|BASHOPTS|BASH_ALIASES|BASH_ARGC|BASH_ARGV|BASH_CMDS|BASH_COMPLETION_COMPAT_DIR|BASH_LINENO|BASH_REMATCH|BASH_SOURCE|BASH_VERSINFO|BASH_VERSION|COLORTERM|COLUMNS|COMP_WORDBREAKS|DBUS_SESSION_BUS_ADDRESS|DEFAULTS_PATH|DESKTOP_SESSION|DIRSTACK|DISPLAY|EUID|GDMSESSION|GDM_LANG|GNOME_KEYRING_CONTROL|GNOME_KEYRING_PID|GPG_AGENT_INFO|GROUPS|HISTCONTROL|HISTFILE|HISTFILESIZE|HISTSIZE|HOME|HOSTNAME|HOSTTYPE|IFS|INSTANCE|JOB|LANG|LANGUAGE|LC_ADDRESS|LC_ALL|LC_IDENTIFICATION|LC_MEASUREMENT|LC_MONETARY|LC_NAME|LC_NUMERIC|LC_PAPER|LC_TELEPHONE|LC_TIME|LESSCLOSE|LESSOPEN|LINES|LOGNAME|LS_COLORS|MACHTYPE|MAILCHECK|MANDATORY_PATH|NO_AT_BRIDGE|OLDPWD|OPTERR|OPTIND|ORBIT_SOCKETDIR|OSTYPE|PAPERSIZE|PATH|PIPESTATUS|PPID|PS1|PS2|PS3|PS4|PWD|RANDOM|REPLY|SECONDS|SELINUX_INIT|SESSION|SESSIONTYPE|SESSION_MANAGER|SHELL|SHELLOPTS|SHLVL|SSH_AUTH_SOCK|TERM|UID|UPSTART_EVENTS|UPSTART_INSTANCE|UPSTART_JOB|UPSTART_SESSION|USER|WINDOWID|XAUTHORITY|XDG_CONFIG_DIRS|XDG_CURRENT_DESKTOP|XDG_DATA_DIRS|XDG_GREETER_DATA_DIR|XDG_MENU_PREFIX|XDG_RUNTIME_DIR|XDG_SEAT|XDG_SEAT_PATH|XDG_SESSION_DESKTOP|XDG_SESSION_ID|XDG_SESSION_PATH|XDG_SESSION_TYPE|XDG_VTNR|XMODIFIERS)\\b",n={pattern:/(^(["']?)\w+\2)[ \t]+\S.*/,lookbehind:!0,alias:"punctuation",inside:null},r={bash:n,environment:{pattern:RegExp("\\$"+t),alias:"constant"},variable:[{pattern:/\$?\(\([\s\S]+?\)\)/,greedy:!0,inside:{variable:[{pattern:/(^\$\(\([\s\S]+)\)\)/,lookbehind:!0},/^\$\(\(/],number:/\b0x[\dA-Fa-f]+\b|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?:[Ee]-?\d+)?/,operator:/--|\+\+|\*\*=?|<<=?|>>=?|&&|\|\||[=!+\-*/%<>^&|]=?|[?~:]/,punctuation:/\(\(?|\)\)?|,|;/}},{pattern:/\$\((?:\([^)]+\)|[^()])+\)|`[^`]+`/,greedy:!0,inside:{variable:/^\$\(|^`|\)$|`$/}},{pattern:/\$\{[^}]+\}/,greedy:!0,inside:{operator:/:[-=?+]?|[!\/]|##?|%%?|\^\^?|,,?/,punctuation:/[\[\]]/,environment:{pattern:RegExp("(\\{)"+t),lookbehind:!0,alias:"constant"}}},/\$(?:\w+|[#?*!@$])/],entity:/\\(?:[abceEfnrtv\\"]|O?[0-7]{1,3}|U[0-9a-fA-F]{8}|u[0-9a-fA-F]{4}|x[0-9a-fA-F]{1,2})/};e.languages.bash={shebang:{pattern:/^#!\s*\/.*/,alias:"important"},comment:{pattern:/(^|[^"{\\$])#.*/,lookbehind:!0},"function-name":[{pattern:/(\bfunction\s+)[\w-]+(?=(?:\s*\(?:\s*\))?\s*\{)/,lookbehind:!0,alias:"function"},{pattern:/\b[\w-]+(?=\s*\(\s*\)\s*\{)/,alias:"function"}],"for-or-select":{pattern:/(\b(?:for|select)\s+)\w+(?=\s+in\s)/,alias:"variable",lookbehind:!0},"assign-left":{pattern:/(^|[\s;|&]|[<>]\()\w+(?:\.\w+)*(?=\+?=)/,inside:{environment:{pattern:RegExp("(^|[\\s;|&]|[<>]\\()"+t),lookbehind:!0,alias:"constant"}},alias:"variable",lookbehind:!0},parameter:{pattern:/(^|\s)-{1,2}(?:\w+:[+-]?)?\w+(?:\.\w+)*(?=[=\s]|$)/,alias:"variable",lookbehind:!0},string:[{pattern:/((?:^|[^<])<<-?\s*)(\w+)\s[\s\S]*?(?:\r?\n|\r)\2/,lookbehind:!0,greedy:!0,inside:r},{pattern:/((?:^|[^<])<<-?\s*)(["'])(\w+)\2\s[\s\S]*?(?:\r?\n|\r)\3/,lookbehind:!0,greedy:!0,inside:{bash:n}},{pattern:/(^|[^\\](?:\\\\)*)"(?:\\[\s\S]|\$\([^)]+\)|\$(?!\()|`[^`]+`|[^"\\`$])*"/,lookbehind:!0,greedy:!0,inside:r},{pattern:/(^|[^$\\])'[^']*'/,lookbehind:!0,greedy:!0},{pattern:/\$'(?:[^'\\]|\\[\s\S])*'/,greedy:!0,inside:{entity:r.entity}}],environment:{pattern:RegExp("\\$?"+t),alias:"constant"},variable:r.variable,function:{pattern:/(^|[\s;|&]|[<>]\()(?:add|apropos|apt|apt-cache|apt-get|aptitude|aspell|automysqlbackup|awk|basename|bash|bc|bconsole|bg|bzip2|cal|cargo|cat|cfdisk|chgrp|chkconfig|chmod|chown|chroot|cksum|clear|cmp|column|comm|composer|cp|cron|crontab|csplit|curl|cut|date|dc|dd|ddrescue|debootstrap|df|diff|diff3|dig|dir|dircolors|dirname|dirs|dmesg|docker|docker-compose|du|egrep|eject|env|ethtool|expand|expect|expr|fdformat|fdisk|fg|fgrep|file|find|fmt|fold|format|free|fsck|ftp|fuser|gawk|git|gparted|grep|groupadd|groupdel|groupmod|groups|grub-mkconfig|gzip|halt|head|hg|history|host|hostname|htop|iconv|id|ifconfig|ifdown|ifup|import|install|ip|java|jobs|join|kill|killall|less|link|ln|locate|logname|logrotate|look|lpc|lpr|lprint|lprintd|lprintq|lprm|ls|lsof|lynx|make|man|mc|mdadm|mkconfig|mkdir|mke2fs|mkfifo|mkfs|mkisofs|mknod|mkswap|mmv|more|most|mount|mtools|mtr|mutt|mv|nano|nc|netstat|nice|nl|node|nohup|notify-send|npm|nslookup|op|open|parted|passwd|paste|pathchk|ping|pkill|pnpm|podman|podman-compose|popd|pr|printcap|printenv|ps|pushd|pv|quota|quotacheck|quotactl|ram|rar|rcp|reboot|remsync|rename|renice|rev|rm|rmdir|rpm|rsync|scp|screen|sdiff|sed|sendmail|seq|service|sftp|sh|shellcheck|shuf|shutdown|sleep|slocate|sort|split|ssh|stat|strace|su|sudo|sum|suspend|swapon|sync|sysctl|tac|tail|tar|tee|time|timeout|top|touch|tr|traceroute|tsort|tty|umount|uname|unexpand|uniq|units|unrar|unshar|unzip|update-grub|uptime|useradd|userdel|usermod|users|uudecode|uuencode|v|vcpkg|vdir|vi|vim|virsh|vmstat|wait|watch|wc|wget|whereis|which|who|whoami|write|xargs|xdg-open|yarn|yes|zenity|zip|zsh|zypper)(?=$|[)\s;|&])/,lookbehind:!0},keyword:{pattern:/(^|[\s;|&]|[<>]\()(?:case|do|done|elif|else|esac|fi|for|function|if|in|select|then|until|while)(?=$|[)\s;|&])/,lookbehind:!0},builtin:{pattern:/(^|[\s;|&]|[<>]\()(?:\.|:|alias|bind|break|builtin|caller|cd|command|continue|declare|echo|enable|eval|exec|exit|export|getopts|hash|help|let|local|logout|mapfile|printf|pwd|read|readarray|readonly|return|set|shift|shopt|source|test|times|trap|type|typeset|ulimit|umask|unalias|unset)(?=$|[)\s;|&])/,lookbehind:!0,alias:"class-name"},boolean:{pattern:/(^|[\s;|&]|[<>]\()(?:false|true)(?=$|[)\s;|&])/,lookbehind:!0},"file-descriptor":{pattern:/\B&\d\b/,alias:"important"},operator:{pattern:/\d?<>|>\||\+=|=[=~]?|!=?|<<[<-]?|[&\d]?>>|\d[<>]&?|[<>][&=]?|&[>&]?|\|[&|]?/,inside:{"file-descriptor":{pattern:/^\d/,alias:"important"}}},punctuation:/\$?\(\(?|\)\)?|\.\.|[{}[\];\\]/,number:{pattern:/(^|\s)(?:[1-9]\d*|0)(?:[.,]\d+)?\b/,lookbehind:!0}},n.inside=e.languages.bash;for(var a=["comment","function-name","for-or-select","assign-left","parameter","string","environment","function","keyword","builtin","boolean","file-descriptor","operator","punctuation","number"],o=r.variable[1].inside,i=0;i{!function(e){var t=/\/\*[\s\S]*?\*\/|\/\/.*|#(?!\[).*/,n=[{pattern:/\b(?:false|true)\b/i,alias:"boolean"},{pattern:/(::\s*)\b[a-z_]\w*\b(?!\s*\()/i,greedy:!0,lookbehind:!0},{pattern:/(\b(?:case|const)\s+)\b[a-z_]\w*(?=\s*[;=])/i,greedy:!0,lookbehind:!0},/\b(?:null)\b/i,/\b[A-Z_][A-Z0-9_]*\b(?!\s*\()/],r=/\b0b[01]+(?:_[01]+)*\b|\b0o[0-7]+(?:_[0-7]+)*\b|\b0x[\da-f]+(?:_[\da-f]+)*\b|(?:\b\d+(?:_\d+)*\.?(?:\d+(?:_\d+)*)?|\B\.\d+)(?:e[+-]?\d+)?/i,a=/|\?\?=?|\.{3}|\??->|[!=]=?=?|::|\*\*=?|--|\+\+|&&|\|\||<<|>>|[?~]|[/^|%*&<>.+-]=?/,o=/[{}\[\](),:;]/;e.languages.php={delimiter:{pattern:/\?>$|^<\?(?:php(?=\s)|=)?/i,alias:"important"},comment:t,variable:/\$+(?:\w+\b|(?=\{))/,package:{pattern:/(namespace\s+|use\s+(?:function\s+)?)(?:\\?\b[a-z_]\w*)+\b(?!\\)/i,lookbehind:!0,inside:{punctuation:/\\/}},"class-name-definition":{pattern:/(\b(?:class|enum|interface|trait)\s+)\b[a-z_]\w*(?!\\)\b/i,lookbehind:!0,alias:"class-name"},"function-definition":{pattern:/(\bfunction\s+)[a-z_]\w*(?=\s*\()/i,lookbehind:!0,alias:"function"},keyword:[{pattern:/(\(\s*)\b(?:array|bool|boolean|float|int|integer|object|string)\b(?=\s*\))/i,alias:"type-casting",greedy:!0,lookbehind:!0},{pattern:/([(,?]\s*)\b(?:array(?!\s*\()|bool|callable|(?:false|null)(?=\s*\|)|float|int|iterable|mixed|object|self|static|string)\b(?=\s*\$)/i,alias:"type-hint",greedy:!0,lookbehind:!0},{pattern:/(\)\s*:\s*(?:\?\s*)?)\b(?:array(?!\s*\()|bool|callable|(?:false|null)(?=\s*\|)|float|int|iterable|mixed|never|object|self|static|string|void)\b/i,alias:"return-type",greedy:!0,lookbehind:!0},{pattern:/\b(?:array(?!\s*\()|bool|float|int|iterable|mixed|object|string|void)\b/i,alias:"type-declaration",greedy:!0},{pattern:/(\|\s*)(?:false|null)\b|\b(?:false|null)(?=\s*\|)/i,alias:"type-declaration",greedy:!0,lookbehind:!0},{pattern:/\b(?:parent|self|static)(?=\s*::)/i,alias:"static-context",greedy:!0},{pattern:/(\byield\s+)from\b/i,lookbehind:!0},/\bclass\b/i,{pattern:/((?:^|[^\s>:]|(?:^|[^-])>|(?:^|[^:]):)\s*)\b(?:abstract|and|array|as|break|callable|case|catch|clone|const|continue|declare|default|die|do|echo|else|elseif|empty|enddeclare|endfor|endforeach|endif|endswitch|endwhile|enum|eval|exit|extends|final|finally|fn|for|foreach|function|global|goto|if|implements|include|include_once|instanceof|insteadof|interface|isset|list|match|namespace|never|new|or|parent|print|private|protected|public|readonly|require|require_once|return|self|static|switch|throw|trait|try|unset|use|var|while|xor|yield|__halt_compiler)\b/i,lookbehind:!0}],"argument-name":{pattern:/([(,]\s*)\b[a-z_]\w*(?=\s*:(?!:))/i,lookbehind:!0},"class-name":[{pattern:/(\b(?:extends|implements|instanceof|new(?!\s+self|\s+static))\s+|\bcatch\s*\()\b[a-z_]\w*(?!\\)\b/i,greedy:!0,lookbehind:!0},{pattern:/(\|\s*)\b[a-z_]\w*(?!\\)\b/i,greedy:!0,lookbehind:!0},{pattern:/\b[a-z_]\w*(?!\\)\b(?=\s*\|)/i,greedy:!0},{pattern:/(\|\s*)(?:\\?\b[a-z_]\w*)+\b/i,alias:"class-name-fully-qualified",greedy:!0,lookbehind:!0,inside:{punctuation:/\\/}},{pattern:/(?:\\?\b[a-z_]\w*)+\b(?=\s*\|)/i,alias:"class-name-fully-qualified",greedy:!0,inside:{punctuation:/\\/}},{pattern:/(\b(?:extends|implements|instanceof|new(?!\s+self\b|\s+static\b))\s+|\bcatch\s*\()(?:\\?\b[a-z_]\w*)+\b(?!\\)/i,alias:"class-name-fully-qualified",greedy:!0,lookbehind:!0,inside:{punctuation:/\\/}},{pattern:/\b[a-z_]\w*(?=\s*\$)/i,alias:"type-declaration",greedy:!0},{pattern:/(?:\\?\b[a-z_]\w*)+(?=\s*\$)/i,alias:["class-name-fully-qualified","type-declaration"],greedy:!0,inside:{punctuation:/\\/}},{pattern:/\b[a-z_]\w*(?=\s*::)/i,alias:"static-context",greedy:!0},{pattern:/(?:\\?\b[a-z_]\w*)+(?=\s*::)/i,alias:["class-name-fully-qualified","static-context"],greedy:!0,inside:{punctuation:/\\/}},{pattern:/([(,?]\s*)[a-z_]\w*(?=\s*\$)/i,alias:"type-hint",greedy:!0,lookbehind:!0},{pattern:/([(,?]\s*)(?:\\?\b[a-z_]\w*)+(?=\s*\$)/i,alias:["class-name-fully-qualified","type-hint"],greedy:!0,lookbehind:!0,inside:{punctuation:/\\/}},{pattern:/(\)\s*:\s*(?:\?\s*)?)\b[a-z_]\w*(?!\\)\b/i,alias:"return-type",greedy:!0,lookbehind:!0},{pattern:/(\)\s*:\s*(?:\?\s*)?)(?:\\?\b[a-z_]\w*)+\b(?!\\)/i,alias:["class-name-fully-qualified","return-type"],greedy:!0,lookbehind:!0,inside:{punctuation:/\\/}}],constant:n,function:{pattern:/(^|[^\\\w])\\?[a-z_](?:[\w\\]*\w)?(?=\s*\()/i,lookbehind:!0,inside:{punctuation:/\\/}},property:{pattern:/(->\s*)\w+/,lookbehind:!0},number:r,operator:a,punctuation:o};var i={pattern:/\{\$(?:\{(?:\{[^{}]+\}|[^{}]+)\}|[^{}])+\}|(^|[^\\{])\$+(?:\w+(?:\[[^\r\n\[\]]+\]|->\w+)?)/,lookbehind:!0,inside:e.languages.php},s=[{pattern:/<<<'([^']+)'[\r\n](?:.*[\r\n])*?\1;/,alias:"nowdoc-string",greedy:!0,inside:{delimiter:{pattern:/^<<<'[^']+'|[a-z_]\w*;$/i,alias:"symbol",inside:{punctuation:/^<<<'?|[';]$/}}}},{pattern:/<<<(?:"([^"]+)"[\r\n](?:.*[\r\n])*?\1;|([a-z_]\w*)[\r\n](?:.*[\r\n])*?\2;)/i,alias:"heredoc-string",greedy:!0,inside:{delimiter:{pattern:/^<<<(?:"[^"]+"|[a-z_]\w*)|[a-z_]\w*;$/i,alias:"symbol",inside:{punctuation:/^<<<"?|[";]$/}},interpolation:i}},{pattern:/`(?:\\[\s\S]|[^\\`])*`/,alias:"backtick-quoted-string",greedy:!0},{pattern:/'(?:\\[\s\S]|[^\\'])*'/,alias:"single-quoted-string",greedy:!0},{pattern:/"(?:\\[\s\S]|[^\\"])*"/,alias:"double-quoted-string",greedy:!0,inside:{interpolation:i}}];e.languages.insertBefore("php","variable",{string:s,attribute:{pattern:/#\[(?:[^"'\/#]|\/(?![*/])|\/\/.*$|#(?!\[).*$|\/\*(?:[^*]|\*(?!\/))*\*\/|"(?:\\[\s\S]|[^\\"])*"|'(?:\\[\s\S]|[^\\'])*')+\](?=\s*[a-z$#])/im,greedy:!0,inside:{"attribute-content":{pattern:/^(#\[)[\s\S]+(?=\]$)/,lookbehind:!0,inside:{comment:t,string:s,"attribute-class-name":[{pattern:/([^:]|^)\b[a-z_]\w*(?!\\)\b/i,alias:"class-name",greedy:!0,lookbehind:!0},{pattern:/([^:]|^)(?:\\?\b[a-z_]\w*)+/i,alias:["class-name","class-name-fully-qualified"],greedy:!0,lookbehind:!0,inside:{punctuation:/\\/}}],constant:n,number:r,operator:a,punctuation:o}},delimiter:{pattern:/^#\[|\]$/,alias:"punctuation"}}}}),e.hooks.add("before-tokenize",(function(t){if(/<\?/.test(t.code)){e.languages["markup-templating"].buildPlaceholders(t,"php",/<\?(?:[^"'/#]|\/(?![*/])|("|')(?:\\[\s\S]|(?!\1)[^\\])*\1|(?:\/\/|#(?!\[))(?:[^?\n\r]|\?(?!>))*(?=$|\?>|[\r\n])|#\[|\/\*(?:[^*]|\*(?!\/))*(?:\*\/|$))*?(?:\?>|$)/g)}})),e.hooks.add("after-tokenize",(function(t){e.languages["markup-templating"].tokenizePlaceholders(t,"php")}))}(Prism)},5873:(e,t,n)=>{var r={"./prism-bash":7874,"./prism-php":9945};function a(e){var t=o(e);return n(t)}function o(e){if(!n.o(r,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return r[e]}a.keys=function(){return Object.keys(r)},a.resolve=o,e.exports=a,a.id=5873},2703:(e,t,n)=>{"use strict";var r=n(414);function a(){}function o(){}o.resetWarningCache=a,e.exports=function(){function e(e,t,n,a,o,i){if(i!==r){var s=new Error("Calling PropTypes validators directly is not supported by the `prop-types` package. Use PropTypes.checkPropTypes() to call them. Read more at http://fb.me/use-check-prop-types");throw s.name="Invariant Violation",s}}function t(){return e}e.isRequired=e;var n={array:e,bigint:e,bool:e,func:e,number:e,object:e,string:e,symbol:e,any:e,arrayOf:t,element:e,elementType:e,instanceOf:t,node:e,objectOf:t,oneOf:t,oneOfType:t,shape:t,exact:t,checkPropTypes:o,resetWarningCache:a};return n.PropTypes=n,n}},5697:(e,t,n)=>{e.exports=n(2703)()},414:e=>{"use strict";e.exports="SECRET_DO_NOT_PASS_THIS_OR_YOU_WILL_BE_FIRED"},4448:(e,t,n)=>{"use strict";var r=n(7294),a=n(7418),o=n(3840);function i(e){for(var t="https://reactjs.org/docs/error-decoder.html?invariant="+e,n=1;n