Fejlesztőknek
Kezdj bele
Témák/Theme SDK/Modules/content

content

Ez az oldal még csak angolul érhető el.

Merchant content: blog posts, legal documents, the FAQ, guides, rich text, Markdown and the contact page.

Ezen az oldalon
import { … } from '@poltura/theme-sdk/content';

Hooks

NameWhat it is
useArticleThe blog post of the post page the component sits on.
useLegalPageThe legal document of the legal page the component sits on.
useFaqThe FAQ groups of the FAQ page the component sits on.
useContactPageThe contact page's heading, wording and the store's contact details, company, bank account and social profiles.
useBlogThe blog posts of the blog page the component sits on: the landing page or a category's.
useGuidesThe guides of the help centre page the component sits on: every category, or one category's guides.
useGuideThe guide of the guide page the component sits on.
useBannersThe merchant's enabled banners in priority order, in the page language.
useCountdownCounts down to a moment, re-rendering every second until it passes.

Parts

NameWhat it is
MarkdownMerchant Markdown drawn as the store's typography, with headings, tables, images and alignment.
RichTextMerchant rich text, such as a product or category description, drawn as the store's typography.
ArticleCardA blog post card: cover image, category, date, title, excerpt and the read link.
FaqAccordionQuestions that open one at a time to show their Markdown answers.
CountdownA ticking hh:mm:ss timer with a clock icon, for sales and offers.
ContentBadgeA small rounded label, such as a category on a cover image; nothing without an icon or label.
ArticleDownloadsThe downloads box of a guide: each file or link with its icon, version, platform and size.
DownloadButtonOne guide file, link or purchase file as a download button.
FileDownloadsEvery file and link of a guide and the product's purchase files as download buttons; nothing when there are none.
ContactInfoCardOne contact channel as a card: icon, name, what it is for and the link to it.
ContactSocialCardThe store's social profiles as a card of icon tiles; nothing without profiles.
CompanyInfoThe company's registered details and bank account side by side, labelled in the page language.

Constants

NameWhat it is
contactRegionsThe contact template's regions, where merchants place blocks.

Types

NameWhat it is
ArticleThe blog post a post page shows, with its body and related posts.
ArticleCategoryA blog category.
ArticlePageOne page of blog posts: the blog's landing page or a category's.
ArticleSummaryA blog post as cards and lists show it, without its body.
ContactPageTextsThe fixed wording of the contact page, in the page language.
ContactPageViewEverything the contact page shows: the store's contact details, company, bank account and social links.
ContentHeadingA heading inside a long text, listed in the "On this page" box.
FaqGroupA group of FAQ items under one heading.
FaqItemOne question and its answer on the FAQ page.
GuideA how-to guide the merchant wrote, shown on its own page and on the products it belongs to.
GuideAttachmentA file or link attached to a guide, such as a manual or a driver.
GuideAttachmentKindWhether a guide attachment is a file to download or a link to follow.
GuideCategoryA guide category of the help centre.
GuidePageThe guide a guide page shows, with its category, headings and related guides.
GuidesViewThe guides a help centre page lists: every category on the landing page, or one category's guides.
LegalFeedSectionA section the store's product feeds add to a legal document, such as the data shared with a price comparison site.
LegalPageThe legal document a legal page shows, such as the terms of service or the privacy policy.
LegalPageTextsThe fixed wording of a legal page.
LegalVersionAn earlier version of a legal document, still readable on its own address.
ProductFileA file the product's buyers download after purchase; before purchase it is listed without a link.
RichTextValueMerchant-written rich text, already sanitised by the host; render it with RichText.
MarkdownPropsProps of Markdown.
RichTextPropsProps of RichText.
ArticleCardPropsProps of ArticleCard.
FaqAccordionPropsProps of FaqAccordion.
BannerTemplateWhich ready-made design a banner started from.
BannerLayoutHow a banner shows: a bar, a dialog, a panel sliding in, or the whole screen.
BannerPositionWhere on the screen a banner sits.
BannerActionWhat a banner button does when pressed.
BannerButtonA button of a banner.
BannerColorsThe colours a banner draws with, each a CSS colour or empty for the theme's own.
BannerA banner the merchant set up, such as an announcement or a discount offer, in the page language.
CountdownTimeTime left until a moment, ticking every second.
CountdownPropsProps of Countdown.
ContentBadgePropsProps of ContentBadge.
ArticleDownloadsPropsProps of ArticleDownloads.
DownloadButtonPropsProps of DownloadButton.
FileDownloadsPropsProps of FileDownloads.
ContactInfoCardPropsProps of ContactInfoCard.
ContactSocialCardPropsProps of ContactSocialCard.
CompanyInfoPropsProps of CompanyInfo.
Utoljára frissítve