Websites v4 docs v8.3.1
    Preparing search index...

    Interface SectionElement

    interface SectionElement {
        activeSearchType?: string;
        backgroundColor?: string;
        backgroundOpacity?: number;
        buttonSize?: ButtonSize;
        buttonVariant?: ButtonVariant;
        channel?: ChannelOption;
        color?: string;
        customSearchForms?: { [name: string]: SectionElement };
        dataAttributes?: Record<string, string>;
        distance?: boolean;
        elements?: SectionElement[];
        expanded?: boolean;
        extraSettings?: Record<string, string>;
        flex?: ResponsiveFlexConfig;
        form?: FormElementConfig;
        geolocate?: boolean;
        hoverColor?: string;
        html?: string;
        icon?: string;
        id: string;
        image?: ImageField;
        items?: SearchFormItem[];
        lettingsPropertyTypes?: string[];
        level?: number;
        locationInputPlaceholder?: string;
        marginBottom?: number;
        marginTop?: number;
        maxBeds?: boolean;
        maxPrice?: boolean;
        minBeds?: boolean;
        minPrice?: boolean;
        overrideGlobal?: boolean;
        propertyTypes?: string[];
        scopedMaxPrice?: number | null;
        scopedMinPrice?: number | null;
        scopedTags?: string;
        social?: SocialElement;
        target?: string;
        thickness?: number;
        type: ElementType;
        url?: string;
        useCustomPropertyTypes?: boolean;
        video?: VideoFieldElement;
    }

    Hierarchy (View Summary)

    Index

    Properties

    activeSearchType? backgroundColor? backgroundOpacity? buttonSize? buttonVariant? channel? color? customSearchForms? dataAttributes? distance? elements? expanded? extraSettings? flex? form? geolocate? hoverColor? html? icon? id image? items? lettingsPropertyTypes? level? locationInputPlaceholder? marginBottom? marginTop? maxBeds? maxPrice? minBeds? minPrice? overrideGlobal? propertyTypes? scopedMaxPrice? scopedMinPrice? scopedTags? social? target? thickness? type url? useCustomPropertyTypes? video?

    Properties

    activeSearchType?: string
    backgroundColor?: string
    backgroundOpacity?: number
    buttonSize?: ButtonSize
    buttonVariant?: ButtonVariant
    channel?: ChannelOption
    color?: string
    customSearchForms?: { [name: string]: SectionElement }
    dataAttributes?: Record<string, string>
    distance?: boolean
    elements?: SectionElement[]
    expanded?: boolean
    extraSettings?: Record<string, string>

    Values for settings a theme registers via ThemeRegistry.extraSearchFormSettings

    flex?: ResponsiveFlexConfig
    form?: FormElementConfig
    geolocate?: boolean
    hoverColor?: string
    html?: string
    icon?: string
    id: string
    image?: ImageField
    items?: SearchFormItem[]
    lettingsPropertyTypes?: string[]

    Custom property types for the lettings channel, on themes that offer per-channel types

    level?: number
    locationInputPlaceholder?: string
    marginBottom?: number
    marginTop?: number
    maxBeds?: boolean
    maxPrice?: boolean
    minBeds?: boolean
    minPrice?: boolean
    overrideGlobal?: boolean
    propertyTypes?: string[]

    Custom property types set on this search form

    scopedMaxPrice?: number | null

    If set, the max price field is pre-populated with this value when this search form is selected

    scopedMinPrice?: number | null

    If set, the min price field is pre-populated with this value when this search form is selected

    scopedTags?: string

    If passed, any searches from this type of search form should be scoped to these tags

    social?: SocialElement
    target?: string
    thickness?: number
    type: ElementType
    url?: string
    useCustomPropertyTypes?: boolean

    Boolean for if this search form is currently using it own custom property types rather than the theme's defaults It is possible to have custom types set then toggled off so a check on propertyTypes doesn't work here

    video?: VideoFieldElement

    Settings

    Member Visibility

    On This Page

    Properties