feature-content-blocks advanced
Everything else the package exports, for when you go beyond its components and hooks, such as your own queries or cache updates. Most projects never need these.
GraphQL documents9
ContentBlocksAssetFields | The fields of an image or file the CMS manages. @evolve-storefront/feature-content-blocks/queries |
ContentBlocksBlockFields | Every block the package renders by default. @evolve-storefront/feature-content-blocks/queries |
ContentBlocksColumnEntryFields | The fields of everything a layout column can hold. @evolve-storefront/feature-content-blocks/queries |
ContentBlocksContentSearch | The pages and articles that match a search term, and the CMS's keyword redirect. @evolve-storefront/feature-content-blocks/queries |
ContentBlocksGetSiteSettings | Which page answers each recurring purpose: contact, terms, privacy and the like. @evolve-storefront/feature-content-blocks/queries |
ContentBlocksLinkFields | The fields of a CMS link; the registered ResourceLink builds its href.@evolve-storefront/feature-content-blocks/queries |
ContentBlocksRichTextFields | The fields of a rich-text block: the vendor-neutral tree with the links and embeds it refers to by id, which the built-in RichText renders for every CMS.@evolve-storefront/feature-content-blocks/queries |
GetContentPage | The CMS page at a path: its heading, intro, lead image, metadata and body blocks. @evolve-storefront/feature-content-blocks/queries |
GetContentSnippet | A reusable CMS snippet by key, with its blocks. @evolve-storefront/feature-content-blocks/queries |
Data and cache helpers6
contentSearchHitHref | The href of a content hit's page. @evolve-storefront/feature-content-blocks |
contentSearchPageType | The PageType of a hit's page, from its __typename; null for a type the schema adds later.@evolve-storefront/feature-content-blocks |
contentSearchRedirectHref | Where the CMS's keyword list sends a search: a URL as given, a page through resolvePageHref as contentSearchHitHref does.@evolve-storefront/feature-content-blocks |
createRegistry | Freeze a registry. @evolve-storefront/feature-content-blocks |
sitePagePath | The path, from the site root, of the page answering purpose; null where the editor picked none or it is not published, so the link it would carry is left out.@evolve-storefront/feature-content-blocks |
contentKeys | react-query key factory for CMS content. @evolve-storefront/feature-content-blocks |
Other functions and constants3
readContentSearch | The pages and articles that match a search term, at most limit (3 by default), and the CMS's keyword redirect.@evolve-storefront/feature-content-blocks/queries |
resourceLinkHref | The destination value names, with anchor appended.@evolve-storefront/feature-content-blocks/content-blocks |
defaultBlocks | Every type the package renders, keyed by the GraphQL type name of the data its component receives. @evolve-storefront/feature-content-blocks/content-blocks |
Types79
ArticleAuthor | Who wrote an article (schema Author), as its byline shows it.@evolve-storefront/feature-content-blocks |
ArticleCard | An article as a card shows it. @evolve-storefront/feature-content-blocks |
ArticleList | Article cards, picked by the editor or the newest matching its filters. @evolve-storefront/feature-content-blocks |
ArticleTopic | What an article is about (schema Topic), as a link to the topic's page.@evolve-storefront/feature-content-blocks |
ArticleTopicHrefResolver | The app's href for a topic's page; its route is the site's. @evolve-storefront/feature-content-blocks |
AudienceType | Schema AudienceType, verbatim: who a block is shown to, applied in the browser.@evolve-storefront/feature-content-blocks |
Block | Anything that can sit at the top level of a page body. @evolve-storefront/feature-content-blocks |
Brand | A brand, resolved by commerce from the key the editor picked. @evolve-storefront/feature-content-blocks |
BrandList | Brand logos that link to their brand pages, in the editor's order. @evolve-storefront/feature-content-blocks |
CampaignBanner | A campaign: an image with the text beside it, and one call to action. @evolve-storefront/feature-content-blocks |
CategoryList | Entrances to categories: the picked ones, else the children of parentCategory.@evolve-storefront/feature-content-blocks |
ColumnEntry | Anything that can sit inside a column. @evolve-storefront/feature-content-blocks |
Columns | Two to four column entries side by side, stacked in order on a narrow screen. @evolve-storefront/feature-content-blocks |
ColumnsRatioType | Schema ColumnsRatioType, verbatim: the width of two columns, in placement order.@evolve-storefront/feature-content-blocks |
ContentAsset | An image or file managed by the CMS. @evolve-storefront/feature-content-blocks |
ContentBlockAttributes | What a caller may put on an entry's root element: the standard HTML surface plus data-*, which React's own attribute types do not cover.@evolve-storefront/feature-content-blocks |
ContentBlockComponent | @evolve-storefront/feature-content-blocks |
ContentBlockData | The GraphQL type behind each key the package renders. @evolve-storefront/feature-content-blocks |
ContentBlockName | Every key the package's own components look up. @evolve-storefront/feature-content-blocks |
ContentBlockRegistry | A map from GraphQL type name to the component that renders it. @evolve-storefront/feature-content-blocks |
ContentImage | @evolve-storefront/feature-content-blocks |
ContentLink | A link with its own label, to one target (schema Link): a page, a product or a URL.@evolve-storefront/feature-content-blocks |
ContentLinkPageType | The kind of page a Link opens: the schema's Page implementations, verbatim.@evolve-storefront/feature-content-blocks |
ContentPage | @evolve-storefront/feature-content-blocks |
ContentSearchHit | A page or article that matches a search (ContentSearchHit).@evolve-storefront/feature-content-blocks |
ContentSearchPage | The page a content hit points at (schema interface Page); __typename says which kind.@evolve-storefront/feature-content-blocks |
ContentSearchPageHrefResolver | The app's href for a page a search links to, such as a catalog page by its category route. @evolve-storefront/feature-content-blocks |
ContentSearchPageTarget | A page a search links to: its path without a leading slash or locale prefix, and its type. @evolve-storefront/feature-content-blocks |
ContentSearchPageType | Schema PageType, verbatim: the kind of page a search sends the shopper to.@evolve-storefront/feature-content-blocks |
ContentSearchResult | What the CMS answers to a search term (ContentSearchResult).@evolve-storefront/feature-content-blocks |
ContentSnippet | Reusable content, keyed rather than routed — a USP band, a service banner. @evolve-storefront/feature-content-blocks |
ContentTeaser | An image beside text, or text alone, with up to two links. @evolve-storefront/feature-content-blocks |
ContentVersion | Draft or published — a preview request asks for the former. @evolve-storefront/feature-content-blocks |
Faq | @evolve-storefront/feature-content-blocks |
FaqGroup | @evolve-storefront/feature-content-blocks |
FaqItem | @evolve-storefront/feature-content-blocks |
Figure | One key figure: a value, what it measures and where it comes from. @evolve-storefront/feature-content-blocks |
FigureList | Two to four key figures. @evolve-storefront/feature-content-blocks |
Hotspot | One product pinned on a shoppable image, at a percentage of its width and height. @evolve-storefront/feature-content-blocks |
LinkVariant | Schema LinkVariantType, verbatim: how prominent a link is where it is a call to action.@evolve-storefront/feature-content-blocks |
Messages | The store's fixed system copy; a null field means the storefront's own default. @evolve-storefront/feature-content-blocks |
OpenGraph | @evolve-storefront/feature-content-blocks |
PageHeadingSource | The fields of a page that PageHeading reads; a content, article and catalog page all fit.@evolve-storefront/feature-content-blocks |
PageMeta | @evolve-storefront/feature-content-blocks |
ProductCategory | A commerce category, as a category list links to it. @evolve-storefront/feature-content-blocks |
ProductList | Products the editor picked, or those a category and filters select. @evolve-storefront/feature-content-blocks |
ProductVariant | The product a ProductList card is made of.@evolve-storefront/feature-content-blocks |
Promo | A card that links somewhere: in a promo list, in a product grid and in a menu. @evolve-storefront/feature-content-blocks |
PromoList | Promo cards in a row, in the editor's order. @evolve-storefront/feature-content-blocks |
registryWrapEntry | The wrapper a registry was built with, if any. @evolve-storefront/feature-content-blocks |
Renderable | Anything the dispatcher can resolve a name from. @evolve-storefront/feature-content-blocks |
ResourceLink | A link the CMS authored. @evolve-storefront/feature-content-blocks |
ResourceLinkType | What a link points at, which decides how a href is built from value.@evolve-storefront/feature-content-blocks |
RichText | Rich text from any CMS, as the framework's vendor-neutral tree. @evolve-storefront/feature-content-blocks |
RichTextDocument | @evolve-storefront/feature-content-blocks |
RichTextEmbed | @evolve-storefront/feature-content-blocks |
RichTextLink | @evolve-storefront/feature-content-blocks |
RichTextLinkKind | LinkKindType: a page of the site by its path, or a URL.@evolve-storefront/feature-content-blocks |
RichTextNode | A node of the rich text tree. @evolve-storefront/feature-content-blocks |
SearchRedirect | Where a keyword rule sends a search (SearchRedirect).@evolve-storefront/feature-content-blocks |
ShoppableImage | An image with products pinned on it. @evolve-storefront/feature-content-blocks |
SitePage | A page SiteSettings points at: its heading, for a link's label, and its path.@evolve-storefront/feature-content-blocks |
SitePurpose | A purpose SiteSettings names a page for.@evolve-storefront/feature-content-blocks |
SiteSettings | Which page answers each recurring purpose; null where none is picked or published. @evolve-storefront/feature-content-blocks |
Step | One step of a step list. @evolve-storefront/feature-content-blocks |
StepList | Two to four numbered steps, in the editor's order. @evolve-storefront/feature-content-blocks |
TableOfContents | Links to the anchors on the page; the block holds only its title. @evolve-storefront/feature-content-blocks |
TableOfContentsEntry | One link of a table of contents: the anchor on the page and the words to show. @evolve-storefront/feature-content-blocks |
Tip | A highlighted tip, in a page body or inside rich text. @evolve-storefront/feature-content-blocks |
Usp | @evolve-storefront/feature-content-blocks |
UspIcon | Schema UspIconType, verbatim: the icon before a selling point's title.@evolve-storefront/feature-content-blocks |
UspList | The store's selling points, two to six of them. @evolve-storefront/feature-content-blocks |
Video | A YouTube video, with its accessible name. @evolve-storefront/feature-content-blocks |
WrapEntry | Wraps every entry the dispatcher renders, whatever its type and wherever it sits. @evolve-storefront/feature-content-blocks |
YoutubeVideo | @evolve-storefront/feature-content-blocks |
PreviewAudience | The variants an editor previews: the visitor who is not logged in, and the customer who is. @evolve-storefront/feature-content-blocks/content-audience |
ArticleTopicLinkRenderer | A link with the app's router — its Link, or a plain anchor by default.@evolve-storefront/feature-content-blocks/content-blocks |
ContentSearchLinkRenderer | A link with the app's router — its Link, or a plain anchor by default.@evolve-storefront/feature-content-blocks/content-blocks |
RenderableBlock | The minimum a renderable entry has to carry: its type, and something to key on. @evolve-storefront/feature-content-blocks/content-blocks |
Not listed: 10 props and options types. They appear as the tables on the pages of what they type.