Fejlesztőknek
Kezdj bele
Témák/Theme SDK/Modules/content/Types: LegalFeedSection to ContentBadgeProps

Types: LegalFeedSection to ContentBadgeProps

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

The types of @poltura/theme-sdk/content, LegalFeedSection to ContentBadgeProps.

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

LegalFeedSection

A section the store's product feeds add to a legal document, such as the data shared with a price comparison site.

idrequiredstring

The section's stable key.

titlerequiredstring

The section heading.

effectiverequiredstring

When the section took effect, already worded.

paragraphsrequiredreadonly string[]

The section's paragraphs, as plain text.

LegalPage

The legal document a legal page shows, such as the terms of service or the privacy policy.

slugrequiredstring

The document's address segment, such as `terms-of-service`.

titlerequiredstring

The document's title.

markdownrequiredstring

The document's body in Markdown; render it with `Markdown`.

effectiveLabelrequiredstring | null

When this version took effect, already worded, or null.

feedSectionsrequiredreadonly LegalFeedSection[]

Sections the store's product feeds add after the body.

isOlderVersionrequiredboolean

Whether the page shows an earlier version rather than the one in force.

currentHrefrequiredstring

The page of the version in force.

previousVersionsrequiredreadonly LegalVersion[]

Earlier versions, newest first.

textsrequiredLegalPageTexts

The page's fixed wording in the page language.

LegalPageTexts

The fixed wording of a legal page.

olderVersionrequiredstring

The notice shown on an earlier version.

viewCurrentVersionrequiredstring

The link from an earlier version to the version in force.

previousVersionsrequiredstring

The heading of the earlier versions list.

LegalVersion

An earlier version of a legal document, still readable on its own address.

idrequiredstring

The version's id.

labelrequiredstring

The version's name, such as `Version 3`.

effectiveFromrequiredstring | null

When the version took effect, already formatted, or null.

hrefrequiredstring

The version's page.

ProductFile

A file the product's buyers download after purchase; before purchase it is listed without a link.

idrequiredstring

The file's id.

titlerequiredstring

The name shown to shoppers, such as `Office 2024 installer`.

fileNamerequiredstring

The file name buyers download, such as `office-2024.exe`.

mimeTyperequiredstring

The file's MIME type.

sizeBytesrequirednumber

The file size in bytes.

versionrequiredstring | null

The version the file is for, or null.

languagerequiredstring | null

The language the file is in: a language code such as `hu`, `multi` for several languages, or null.

variantIdrequiredstring | null

The variant whose buyers get it, or null when every variant's buyers do.

RichTextValue

Merchant-written rich text, already sanitised by the host; render it with RichText.

htmlrequiredstring

The sanitised HTML.

MarkdownProps

Props of Markdown.

sourcerequiredstring

The Markdown to draw; raw HTML in it is sanitised.

density'regular' | 'compact'

Tighter spacing, for short answers inside cards.

classNamestring

Classes added to the wrapper.

RichTextProps

Props of RichText.

valuerequiredRichTextValue | null

The sanitised rich text, or null to draw nothing.

classNamestring

Classes added to the wrapper.

ArticleCardProps

Props of ArticleCard.

articlerequiredArticleSummary

The post to show.

readLabelrequiredstring

The call to read the post, such as `Read article`.

variant'default' | 'featured'

A featured card gets the larger title and image.

showDateboolean

Whether the publication date shows; defaults to true.

showExcerptboolean

Whether the excerpt shows; defaults to true.

FaqAccordionProps

Props of FaqAccordion.

itemsrequiredreadonly FaqItem[]

The questions, in order.

BannerTemplate

Which ready-made design a banner started from.

type BannerTemplate = 'announcement' | 'ageGate' | 'newsletter' | 'discount' | 'slideInPromo' | 'maintenance' | 'comingSoon' | 'blank'

BannerLayout

How a banner shows: a bar, a dialog, a panel sliding in, or the whole screen.

type BannerLayout = 'bar' | 'modal' | 'slideIn' | 'fullscreen'

BannerPosition

Where on the screen a banner sits.

type BannerPosition = 'top' | 'bottom' | 'center' | 'bottomLeft' | 'bottomRight'

BannerAction

What a banner button does when pressed.

type BannerAction = 'link' | 'dismiss' | 'accept' | 'decline'

BannerButton

A button of a banner.

labelrequiredstring

The button label.

actionrequiredBannerAction

What the button does.

hrefrequiredstring

Where a `link` button goes; empty for the other actions.

BannerColors

The colours a banner draws with, each a CSS colour or empty for the theme's own.

backgroundrequiredstring

The background.

textrequiredstring

The text.

accentrequiredstring

The buttons and highlights.

accentTextrequiredstring

Text on the accent colour.

A banner the merchant set up, such as an announcement or a discount offer, in the page language.

idrequiredstring

The banner's id.

namerequiredstring

The merchant's name for it, never shown to shoppers.

templaterequiredBannerTemplate

The design it started from.

layoutrequiredBannerLayout

How it shows.

positionrequiredBannerPosition

Where it sits.

eyebrowrequiredstring

The small line above the heading.

headingrequiredstring

The heading.

bodyrequiredstring

The body text.

noterequiredstring

The small print under the body.

imagerequiredMediaImageRef | null

The picture, or null.

primaryrequiredBannerButton | null

The main button, or null.

secondaryrequiredBannerButton | null

The second button, or null.

coderequiredstring | null

The discount code it shows, or null.

countdownTorequiredstring | null

When its countdown ends, as an ISO 8601 string, or null without a countdown.

colorsrequiredBannerColors

The colours it draws with.

CountdownTime

Time left until a moment, ticking every second.

daysrequirednumber

Whole days left.

hoursrequirednumber

Hours left after the days.

minutesrequirednumber

Minutes left after the hours.

secondsrequirednumber

Seconds left after the minutes.

expiredrequiredboolean

Whether the moment has passed.

validrequiredboolean

Whether the moment could be read; false for an empty or broken value.

CountdownProps

Props of Countdown.

hoursrequirednumber

Hours left.

minutesrequirednumber

Minutes left after the hours.

secondsrequirednumber

Seconds left after the minutes.

classNamestring

Classes added to the wrapper.

ContentBadgeProps

Props of ContentBadge.

iconReactNode

An icon before the label.

labelstring

The label.

variant'overlay' | 'muted'

`overlay` sits on pictures, `muted` on the page; `overlay` when omitted.

classNamestring

Classes added to the badge.

Utoljára frissítve