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

forms

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

Store forms: the merchant's published forms, the newsletter sign-up and the contact form.

Ezen az oldalon

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

Hooks

Name	What it is
`useStoreForm`	The surrounding form's state and actions, for your own fields and buttons inside `StoreForm`.
`useStoreFormField`	One field of the surrounding form, for a control of your own.
`useFormActions`	The actions that open a merchant's form in a dialog or side panel.
`useNewsletter`	The store's newsletter: whether it takes sign-ups and the wording to ask with.

Parts

Name	What it is
`FormField`	One field of the surrounding form with its label, control, help and error; nothing while hidden.
`FieldControl`	The platform control of one field: input, text area, choices, checkbox, date or file picker.
`SubmitButton`	The surrounding form's send button, which moves to the next step on multi-step forms.
`FormTrigger`	A button that opens a published form in a dialog or side panel, loading it on hover.
`FormPopup`	Opens a merchant's form by itself after a delay, as often as `frequency` allows; draws nothing.
`NewsletterTrigger`	A button that opens the newsletter sign-up in a dialog or side panel; nothing when the newsletter is off.

Defaults

Name	What it is
`StoreForm`	A merchant's published form, drawn with its fields, steps, validation, captcha and success message.
`NewsletterForm`	The newsletter sign-up, inline, stacked, as the footer column or as a full-width band; nothing when it is off.
`ContactForm`	The store's contact form: name, email, subject and message, sent to the merchant's inbox.

Types

Name	What it is
`FormFieldType`	What a form field asks for, which decides the control it draws.
`FormFieldOption`	One choice of a select, radio or multi-select field.
`StoreFormFieldView`	A field of a published form, already in the page language.
`FormValue`	The value of one field: text, a number, a ticked box or the picked choices.
`StoreFormStatus`	Where a form is in its life: loading, ready to fill in, missing, or sent.
`StoreFormFile`	A file the shopper picked for a file field.
`StoreFormTexts`	The fixed wording of a form's buttons, in the page language.
`StoreFormState`	A published form with its values, errors and the actions that fill it in and send it.
`StoreFormFieldState`	One field of the surrounding form, with its value and error.
`StoreFormLayout`	How a form's fields sit: one under another, or two per row on wide screens.
`StoreFormAppearance`	The surface a form draws on.
`StoreFormChrome`	Whether a form draws its title, description and card, or only its fields.
`StoreFormCopy`	The theme's own wording for a form; empty values keep the merchant's.
`StoreFormProps`	Props of `StoreForm`.
`FormFieldRender`	What a `FormField` render function receives.
`FormFieldProps`	Props of `FormField`.
`FieldControlProps`	Props of `FieldControl`.
`SubmitButtonProps`	Props of `SubmitButton`.
`FormDisplay`	Whether a form opens as a dialog or as a side panel.
`FormWidth`	How wide an opened form is.
`OpenFormInput`	A form to open in a dialog or side panel.
`FormActions`	The actions that open a published form over the page.
`FormTriggerProps`	Props of `FormTrigger`.
`FormPopupFrequency`	How often a form that opens by itself opens again for one visitor: once ever, once a session, or after 30 days.
`FormPopupProps`	Props of `FormPopup`.
`NewsletterTexts`	The newsletter wording, from the theme settings over the platform's own, and the store's consent sentence.
`NewsletterState`	Whether the store takes newsletter sign-ups, and the wording to ask with.
`NewsletterLayout`	Where a newsletter form sits, which decides its look.
`NewsletterFormProps`	Props of `NewsletterForm`.
`NewsletterTriggerProps`	Props of `NewsletterTrigger`.
`ContactFormProps`	Props of `ContactForm`; every wording falls back to the platform's own.

Utoljára frissítve 2026. okt. 29.