@headstartwp/core
@headstartwp/coreis the core package that houses framework-agnostic components and utilities for building headless sites with WordPress.
In addition to the default export, this package also exports:
@headstartwp/core/react: React Components and Custom Hooks@headstartwp/core/utils: An additional export that only includes small utility functions. Useful if you don't want to use the whole framework.
Installation
npm install --save @headstartwp/core
Support Level
Active: 10up is actively working on this, and we expect to continue work for the foreseeable future including keeping tested up to the most recent version of WordPress. Bug reports, feature requests, questions, and pull requests are welcome.
Like what you see?
DOM Helpers
Data Fetching
- AbstractFetchStrategy
- AppSettingsStrategy
- AuthorArchiveFetchStrategy
- PostOrPostsFetchStrategy
- PostsArchiveFetchStrategy
- SearchFetchStrategy
- SearchNativeFetchStrategy
- SinglePostFetchStrategy
- TaxonomyTermsStrategy
- VerifyTokenFetchStrategy
- apiGet
- apiPost
Data Handling
Other
- react
- LOGTYPE
- Comment
- ConfigError
- Element
- EndpointError
- FetchError
- FrameworkError
- NotFoundError
- ProcessingInstruction
- Text
- AppEntity
- AttachmentEntity
- AuthorEntity
- AvatarUrls
- CommentEntity
- EndpointParams
- Entity
- FetchOptions
- FetchResponse
- FilterDataOptions
- HTMLReactParserOptions
- IDataWPBlock
- Integration
- MenuItemEntity
- PageEntity
- PageInfo
- PolylangIntegration
- PostEntity
- PostOrPostsParams
- PostParams
- PostsArchiveParams
- PostSearchEntity
- PostTypeEntity
- Rendered
- RenderedWithBlockStyles
- RevisionEntity
- SearchEntity
- SearchObjectEntity
- SearchParams
- TaxonomyArchiveParams
- TaxonomyEntity
- TermEntity
- TermSearchEntity
- TokenEntity
- TypeEntity
- VerifyTokenParams
- YoastSEOIntegration
- AppQueryProps
- AppQueryResult
- BlockSettingQuery
- CustomPostType
- CustomPostTypes
- CustomTaxonomies
- CustomTaxonomy
- DOMNode
- FetchPostsOrPostsReturnType
- FetchStrategyCacheConfig
- FetchStrategyCacheHandler
- FetchStrategyCacheHandlerOptions
- HeadlessConfig
- HTMLParser2Options
- I18NConfig
- Integrations
- isAnchorTagOptions
- isBlockOptions
- isImageTagOptions
- Matcher
- NormalizedDataForCache
- PageType
- ParsedBlock
- PostOrPostsFetchStrategyResult
- PreviewConfig
- QueriedObject
- QueryProps
- Redirect
- RedirectData
- RedirectStrategy
- removeSourceUrlType
- YoastJSON
- authorArchivesMatchers
- DEFAULT_BLOCK_ELEMENT
- defaultElement
- endpoints
- getHeadlessConfig
- ksesAllowedList
- postMatchers
- postsMatchers
- searchMatchers
- setHeadlessConfig
- youtubeEmbedRegex
- addQueryArgs
- asyncForEach
- attributesToProps
- buildQueryString
- decodeHtmlSpeciaChars
- domToReact
- executeFetchStrategy
- fetchAppSettings
- fetchAuthorArchive
- fetchPost
- fetchPostOrPosts
- fetchPosts
- fetchRedirect
- fetchSearch
- fetchTerms
- flatToHierarchical
- getAttributes
- getCustomPostType
- getCustomPostTypes
- getCustomPostTypesSlugs
- getCustomTaxonomies
- getCustomTaxonomy
- getCustomTaxonomySlugs
- getHeadstartWPConfig
- getHostUrl
- getObjectProperty
- getPageTypeForQuery
- getQueryArgs
- getQueryString
- getSite
- getSiteByHost
- getSiteBySourceUrl
- getThemeSetting
- getWPUrl
- HTMLReactParser
- htmlToDOM
- isElement
- isExternalUrl
- isInternalLink
- isWordPressBlock
- log
- parseBlockAttributes
- prepareFetchStrategy
- removeFieldsFromPostRelatedData
- removeSourceUrl
- setHeadstartWPConfig
- stripTags
- warn