Témák

Témák/Theme SDK/Modules/elements

elements

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

Authoring: define and override sections and blocks, fields, slots, inline editing and child blocks.

Ezen az oldalon

import { … } from '@poltura/theme-sdk/elements';

Hooks

Name	What it is
`useElement`	The section or block instance currently drawing.
`useChildBlocks`	The shown children of the current element in one region, in authored order and in the shopper's language.
`useHasElementBackground`	Whether the element has a background: an image or video the merchant gave it.
`useIsPageLead`	Whether the section being drawn opens the page, so its picture is the largest one above the fold.

Parts

Name	What it is
`Slot`	Draws the children of the current section or block in one region, each through its own component and frame.
`EditableText`	A plain-text setting of the current element, editable in place on the customizer canvas; nothing when empty.
`EditableRichText`	A rich-text setting of the current element, editable in place on the customizer canvas.
`ElementBackground`	The background the merchant styled the current element with: image, video or overlay; nothing when unset.
`ElementDividers`	The shape dividers the merchant set on the current element's edges; nothing when unset.

Definers

Name	What it is
`defineSection`	Declares a section: its type key, inspector settings, children and the component that draws it.
`defineBlock`	Declares a block that draws itself inside the frame the platform puts around each instance.
`defineThemeSettings`	Declares the theme settings panel in `src/settings.ts`: its groups and their `field.*` settings, keyed by their path in the theme's values.

Functions

Name	What it is
`overrideSection`	Swaps the renderer of a platform section type; the platform keeps its schema, inspector and data.
`overrideBlock`	Swaps the renderer of a platform block type everywhere it appears; the platform keeps its schema.
`fieldSet`	A group of settings several elements share, such as a button's label and link; each call spreads its fields into a schema as `<prefix>_<key>`.
`lazyBlock`	A component whose code loads in its own chunk, server-rendered unless `ssr` is false.

Constants

Name	What it is
`field`	The setting builders a definition's `settings` object is written with.
`ELEMENT_CATEGORIES`	Every picker group, in picker order.
`ELEMENT_WILDCARD`	In `accepts`, admits any element.
`THEME_BLOCK_WILDCARD`	In `accepts`, admits the theme's and the installed apps' blocks.
`STYLE_CAPABILITIES`	Every style group an element can offer.

Types

Name	What it is
`LinkValue`	The stored value of a link field: a bare URL or path, or the link with its options.
`PlatformBlockSettings`	The settings of a platform block type, as the merchant set them.
`PlatformBlockType`	A block type the platform ships.
`PlatformSectionSettings`	The settings of a platform section type, as the merchant set them.
`PlatformSectionType`	A section type the platform ships.
`MediaValue`	The stored value of a media field: a `media://` library file, an `asset://` theme file, an image URL, or `''` when unset.
`IconValue`	The stored value of an icon field: a content icon name, `lucide:<name>`, `logo:<id>` for a platform logo, or `svg:<markup>` for a custom icon.
`SettingsSchema`	A settings object: setting id to `field.*` result, in inspector order.
`SettingsOf`	The settings a component receives for a schema; fields with a `default` are always present.
`FieldSpec`	What a `field.*` builder returns: one setting's inspector description, carrying its value type.
`FieldBuilders`	The `field` builders, one per setting kind: text, number, colour, image, link, product and more.
`FieldSet`	A reusable group of settings: call it with a prefix and spread the result into `settings`.
`FieldSetOptions`	What a field set's call takes beside its prefix: an optional heading, and this use's own defaults and locale paths.
`ThemeSettingsDefinition`	The theme settings `src/settings.ts` declares: the panel's groups and their fields.
`ThemeSettingsGroupDefinition`	One group of the theme settings panel: its id, heading and `field.*` settings by path.
`ElementCategory`	A picker group an element is listed under, such as `marketing` or `product`.
`ElementIntent`	What a section is for: its `kinds`, `moods`, `photos`, `products`, `height` and `source`.
`StyleCapability`	A group of style controls the inspector's Style tab offers, such as `spacing` or `background`.
`ElementIconId`	An icon of the element picker and navigator.
`ElementWording`	Own wording of an element, field, preset or slot by admin language, such as `{ hu: { label: 'Csempék' } }`.
`ElementSlot`	A named region of an element that `Slot` draws, with its label and accepted children.
`ElementPreset`	A named starting configuration an element offers on insert; a plain insert applies `default`, other presets get their own tiles.
`ElementScope`	A data scope an element reads from above or opens for its children: `product` or `collection`.
`SectionGroup`	A page-wide section group outside the templates: `header` or `footer`.
`BlockFrameTag`	The box the platform draws around each block instance: `div`, `li`, `span`, or `self` for platform elements.
`ElementStyle`	Style values in theme tokens, as an element instance stores them.
`ElementSeed`	A child element a static block or preset starts with.
`ElementSettingsSeed`	Settings an instance starts with, by setting id.
`ElementAttrs`	Attributes to spread on the element's root node, so merchant styling, anchors and the editor reach it.
`ElementRenderProps`	What an element component receives for an already computed settings type.
`ElementProps`	What a section or block component receives for its settings schema.
`ElementComponent`	A component that draws an element from its settings.
`AcceptedBlock`	A `defineBlock` result named in `accepts` instead of its type key.
`StaticBlockDefinition`	One fixed child of a section or block that merchants can hide and restyle but never move or delete.
`ElementBlocksRule`	Which child elements an element accepts, in the customizer and in saved layouts.
`ElementContextRule`	Scopes an element reads from above (`requires`) and opens for its children (`provides`).
`ElementDefinitionBase`	What sections and blocks share in their definition; every property is literal data the compiler reads statically.
`SectionDefinition`	The object passed to `defineSection`.
`BlockDefinition`	The object passed to `defineBlock`.
`SectionElement`	A declared section, ready to export from a file under `src/sections`.
`BlockElement`	A declared block, ready to export from a file under `src/blocks` or `src/sections`.
`SectionOverride`	A theme renderer for a platform section type whose schema, inspector and data the platform keeps.
`BlockOverride`	A theme renderer for a platform block type whose schema, inspector and data the platform keeps.
`SlotTag`	The element type of a slot's box; `none` draws the children straight into the parent.
`SlotProps`	Props of `Slot`.
`EditableTextTag`	A tag `EditableText` can render.
`EditableTextProps`	Props of `EditableText`.
`EditableRichTextProps`	Props of `EditableRichText`.
`ElementContext`	The element instance currently drawing.
`ChildBlock`	A child instance of the current element.
`LazyBlockOptions`	Options of `lazyBlock`.

Utoljára frissítve 2026. nov. 01.