Websites v4 docs v5.2.4
    Preparing search index...

    Module API Reference/State

    Enumerations

    ButtonRounding
    ButtonSize
    ButtonVariant
    ChannelOption
    ContainerWidth
    DisplayAsElementOption
    ElementType
    FloatingButtonPosition
    FontSource
    FooterNodeType
    Justify
    Overlap
    PageName
    SectionHeight
    SocialType
    TypographyCase
    VisibilityStatus

    Interfaces

    AnalyticsScriptItem
    AreaGuideFields
    ArticleFields
    ArticleListFields
    ArticlesConfig
    BranchesConfig
    BranchFields
    BranchListFields
    BrandingRule
    CalculatorConfig
    CarouselConfig
    CustomFields
    CustomFormConfig
    CustomPagesConfig
    FlexConfig
    FloatingButton
    Font
    FooterDivider
    FooterElement
    FooterHeading
    FooterImage
    FooterItem
    FooterNodeAddress
    FooterSection
    FooterText
    FormElementConfig
    GenericConfig
    GenericMediaConfig
    GlobalConfig
    GlobalConfigTypographyElement
    HomeFields
    ImageBannerConfig
    ImageWithTextConfig
    InterstitalFields
    MapConfig
    MultiItemConfig
    NodeAddress
    PageConfig
    PropertyFields
    PropertyListFields
    PropertyListRules
    PropertyRules
    PropertySliderConfig
    ResponsiveFlexConfig
    RichTextConfig
    ScriptItem
    SearchForm
    SearchFormItem
    Section
    SectionElement
    SelectedSection
    SharingPermissionProps
    SharingPermissionsProps
    StaffConfig
    StaffFields
    StaffListFields
    StampDutyConfig
    TestimonialsConfig
    Typography
    ValuationConfig
    VideoBannerConfig
    VideoFieldElement

    Type Aliases

    ConfigState
    CustomFormElement
    CustomFormElementVisibility
    DefaultThemeSettings
    DisplayAsElementOptionAttributes
    HeadingField
    Iframe
    ImageBannerImageHeightClasses
    ImageField
    LinkField
    MixedSection
    SliderConfig
    SocialElement
    TextField
    ThemeSetting
    ThemeSettingsConfig
    ThemeSettingValue
    VideoField

    Variables

    addCustomSearchForm
    addElement
    addItem
    addSection
    configReducer
    configSlice
    deleteCustomSearchForm
    deleteFloatingButton
    deleteNode
    elementTypeLabels
    moveNode
    newBrandingRule
    newCampaign
    newFloatingButton
    removeSectionOverride
    selectSelectedSection
    setActiveBreakpoint
    setAreaSections
    setBrandingRules
    setCampaign
    setCampaignsConfig
    setElement
    setField
    setFloatingButton
    setFooterNodes
    setFooterSections
    setFooterSelection
    setFreezeReorder
    setGlobalConfig
    setGlobalConfigField
    setGlobalConfigId
    setGlobalConfigTypography
    setGlobalConfigVariable
    setGlobalConfigVariables
    setItem
    setOverrideField
    setPageConfig
    setPageConfigId
    setPageField
    setPageMetadataField
    setPreviewMode
    setSection
    setSectionAppliedTo
    setSectionName
    setSectionOverride
    setSectionSchemas
    setSelectedField
    setSelectedSearchForm
    setSelection
    setSitePath
    setTheme
    setThemeSettingsConfig
    setThemeSettingsConfigField
    setUnsavedChanges
    toggleSharedWith

    Functions

    getParentAddress
    selectActiveBreakpoint
    selectAreaSection
    selectAreaSections
    selectCampaignsConfig
    selectField
    selectFooterNode
    selectFooterSections
    selectFooterSelection
    selectFreezeReorder
    selectGlobalConfig
    selectGlobalConfigBrandingRules
    selectGlobalConfigField
    selectGlobalConfigFloatingButton
    selectGlobalConfigTypography
    selectGlobalConfigVariables
    selectHasOverride
    selectPageAgencyId
    selectPageConfig
    selectPageField
    selectPageMetadata
    selectPreviewMode
    selectSectionSchemas
    selectSectionSettings
    selectSelectedAreaName
    selectSelectedElement
    selectSelectedField
    selectSelectedItem
    selectSelectedItemSettings
    selectSelectedNodeDefaultLayoutConfig
    selectSelectedOverrideField
    selectSelectedOverrideSection
    selectSelectedSearchForm
    selectSelectedSectionField
    selectSelectionAddress
    selectSharedWith
    selectSiblings
    selectSitePath
    selectTheme
    selectThemeSettingsConfig
    selectThemeSettingsConfigField
    selectUnsavedChanges