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

    Interface SearchForm

    interface SearchForm {
        activeSearchType?: string;
        backgroundOpacity?: number;
        buttonVariant?: ButtonVariant;
        channel?: ChannelOption;
        color?: string;
        customSearchForms?: { [name: string]: SectionElement };
        distance?: boolean;
        expanded?: boolean;
        extraSettings?: Record<string, string>;
        geolocate?: boolean;
        items?: SearchFormItem[];
        lettingsPropertyTypes?: string[];
        locationInputPlaceholder?: string;
        maxBeds?: boolean;
        maxPrice?: boolean;
        minBeds?: boolean;
        minPrice?: boolean;
        overrideGlobal?: boolean;
        propertyTypes?: string[];
        scopedMaxPrice?: number | null;
        scopedMinPrice?: number | null;
        scopedTags?: string;
        useCustomPropertyTypes?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    activeSearchType? backgroundOpacity? buttonVariant? channel? color? customSearchForms? distance? expanded? extraSettings? geolocate? items? lettingsPropertyTypes? locationInputPlaceholder? maxBeds? maxPrice? minBeds? minPrice? overrideGlobal? propertyTypes? scopedMaxPrice? scopedMinPrice? scopedTags? useCustomPropertyTypes?

    Properties

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

    Values for settings a theme registers via ThemeRegistry.extraSearchFormSettings

    geolocate?: boolean
    items?: SearchFormItem[]
    lettingsPropertyTypes?: string[]

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

    locationInputPlaceholder?: string
    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

    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

    Settings

    Member Visibility

    On This Page

    Properties