Websites v4 docs v5.2.4
Preparing search index...
API Reference/Hooks
Module API Reference/Hooks
Enumerations
ActionType
Direction
MortgageFinderActionType
Status
UpdateFrequencyStatus
Interfaces
ContextMenuHook
MenuPosition
MortgageFinderState
MortgageProductResult
PropertyTypeOption
UseBranchesParams
UseClientSectionControlResult
UseSearchFormResult
UseSectionVariantControlResult
Type Aliases
Action
BedroomOption
DistanceOption
FrequencyOption
MortgageCalculatorProps
MortgageCalculatorResult
MortgageState
MultiSelectOption
PaginationUIData
PriceOption
UseArticlesSortOrderResult
UseBranchSearchFormResult
UseDynamicMenuItems
UseLoadPropertiesProps
UseLoadPropertiesResults
UsePaginationUIResult
UsePropertiesMapEventsOptions
UsePropertiesMapEventsResults
UseSearchPropertyStatus
UseSortOrderResult
UseStampDutyCalculatorProps
UseStampDutyCalculatorResult
Variables
defaultBedroomOptions
defaultDistanceOptions
defaultLettingsPriceOptions
defaultSalesPriceOptions
frequencyOptions
Functions
getPriceBracketIndex
useAgency
useArticleLinks
useArticlesSearchForm
useArticlesSortOrder
useBranches
useBranchesSearchForm
useCalculateMortgage
useCalculateRentAffordability
useCancelBodyScroll
useClientSectionControl
useColorMode
useContextMenu
useCookies
useCustomForm
useDatePicker
useDynamicMenuItems
useElementHeight
useFillHeight
useGenerateSearchFromProperty
useGlobalConfig
useHash
useHighlight
useIsBodyScrollCanceled
useLoadProperties
useLocalStorage
useMortgageFinder
useNavCaseClass
useOnClickOutside
usePageName
usePaginationUI
usePropertiesMapEvents
usePropertiesView
usePropertyBrandColor
usePropertyLinks
useRegisterUser
useRenderVariables
useScrollDirection
useScrolledDown
useScrollspy
useScrollToTop
useSearchForm
useSearchFrequenceyTransition
useSearchPropertyStatus
useSectionVariantControl
useSetCssValues
useSortOrder
useStaffSearch
useStampDutyCalculator
useSubmitSearch
useThemePreferences
useThemeRegistry
useThemeSettings
useTimePicker
useUserProfile
useWindowDimensions
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Enumerations
Action
Type
Direction
Mortgage
Finder
Action
Type
Status
Update
Frequency
Status
Interfaces
Context
Menu
Hook
Menu
Position
Mortgage
Finder
State
Mortgage
Product
Result
Property
Type
Option
Use
Branches
Params
Use
Client
Section
Control
Result
Use
Search
Form
Result
Use
Section
Variant
Control
Result
Type Aliases
Action
Bedroom
Option
Distance
Option
Frequency
Option
Mortgage
Calculator
Props
Mortgage
Calculator
Result
Mortgage
State
Multi
Select
Option
Pagination
UI
Data
Price
Option
Use
Articles
Sort
Order
Result
Use
Branch
Search
Form
Result
Use
Dynamic
Menu
Items
Use
Load
Properties
Props
Use
Load
Properties
Results
Use
Pagination
UI
Result
Use
Properties
Map
Events
Options
Use
Properties
Map
Events
Results
Use
Search
Property
Status
Use
Sort
Order
Result
Use
Stamp
Duty
Calculator
Props
Use
Stamp
Duty
Calculator
Result
Variables
default
Bedroom
Options
default
Distance
Options
default
Lettings
Price
Options
default
Sales
Price
Options
frequency
Options
Functions
get
Price
Bracket
Index
use
Agency
use
Article
Links
use
Articles
Search
Form
use
Articles
Sort
Order
use
Branches
use
Branches
Search
Form
use
Calculate
Mortgage
use
Calculate
Rent
Affordability
use
Cancel
Body
Scroll
use
Client
Section
Control
use
Color
Mode
use
Context
Menu
use
Cookies
use
Custom
Form
use
Date
Picker
use
Dynamic
Menu
Items
use
Element
Height
use
Fill
Height
use
Generate
Search
From
Property
use
Global
Config
use
Hash
use
Highlight
use
Is
Body
Scroll
Canceled
use
Load
Properties
use
Local
Storage
use
Mortgage
Finder
use
Nav
Case
Class
use
On
Click
Outside
use
Page
Name
use
Pagination
UI
use
Properties
Map
Events
use
Properties
View
use
Property
Brand
Color
use
Property
Links
use
Register
User
use
Render
Variables
use
Scroll
Direction
use
Scrolled
Down
use
Scrollspy
use
Scroll
To
Top
use
Search
Form
use
Search
Frequencey
Transition
use
Search
Property
Status
use
Section
Variant
Control
use
Set
Css
Values
use
Sort
Order
use
Staff
Search
use
Stamp
Duty
Calculator
use
Submit
Search
use
Theme
Preferences
use
Theme
Registry
use
Theme
Settings
use
Time
Picker
use
User
Profile
use
Window
Dimensions
Websites v4 docs v5.2.4
Loading...