Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

Functions

Const area

  • area(state: State): string

Const autocomplete

Const autocompleteCategoryField

  • autocompleteCategoryField(state: State): string

Const autocompleteCategoryValues

  • autocompleteCategoryValues(state: State): string[]

Const autocompleteNavigations

Const autocompleteProducts

Const autocompleteQuery

  • autocompleteQuery(state: State): string

Const autocompleteSuggestions

Const autocompleteTemplate

Const availableNavigations

Const availablePastPurchaseNavigations

Const collection

  • collection(state: State): string

Const collectionIndex

  • collectionIndex(state: State, name: string): number

Const collections

Const config

Const currentQuery

  • currentQuery(state: State): string

Const defaultCollection

  • defaultCollection(state: State): string

Const details

Const detailsSiteParams

Const detailsTemplate

Const didYouMean

  • didYouMean(state: State): string[]

Const fields

  • fields(state: State): string[]

Const findProduct

Const getLimitedCountDisplay

  • getLimitedCountDisplay(count: number): string

Const getSelected

Const hasMoreRefinements

  • hasMoreRefinements(state: State, navigationId: string): boolean

Const history

Const infiniteScroll

Const isFetching

  • isFetching(state: State, value?: keyof IsFetching): false | true | IsFetching

Const isPastPurchaseRefinementDeselected

  • isPastPurchaseRefinementDeselected(state: State, navigationId: string, index: number): boolean
  • Finds the past purchase refinement based on the given navigationId and index and returns true if it is not selected, false otherwise.

    Parameters

    • state: State
    • navigationId: string
    • index: number

    Returns boolean

Const isPastPurchaseRefinementSelected

  • isPastPurchaseRefinementSelected(state: State, navigationId: string, index: number): boolean
  • Finds the past purchase refinement based on the given navigationId and index and returns true if it is selected, false otherwise.

    Parameters

    • state: State
    • navigationId: string
    • index: number

    Returns boolean

Const isRefinementDeselected

  • isRefinementDeselected(state: State, navigationId: string, index: number): boolean
  • Finds the refinement based on the given navigationId and index and returns true if it is not selected, false otherwise.

    Parameters

    • state: State
    • navigationId: string
    • index: number

    Returns boolean

Const isRefinementSelected

  • isRefinementSelected(state: State, navigationId: string, index: number): boolean
  • Finds the refinement based on the given navigationId and index and returns true if it is selected, false otherwise.

    Parameters

    • state: State
    • navigationId: string
    • index: number

    Returns boolean

Const location

Const navigation

Const navigationSort

Const navigations

Const navigationsObject

Const page

  • page(state: State): number

Const pageObject

Const pageSize

  • pageSize(state: State): number

Const pageSizeIndex

  • pageSizeIndex(state: State): number

Const pageSizes

Const pastPurchaseAllRecordCount

  • pastPurchaseAllRecordCount(state: State): number

Const pastPurchaseCurrentRecordCount

  • pastPurchaseCurrentRecordCount(state: State): number

Const pastPurchaseNavigation

Const pastPurchaseNavigations

Const pastPurchaseNavigationsObject

Const pastPurchasePage

  • pastPurchasePage(state: State): number

Const pastPurchasePageObject

Const pastPurchasePageSize

  • pastPurchasePageSize(state: State): number

Const pastPurchasePageSizeIndex

  • pastPurchasePageSizeIndex(state: State): number

Const pastPurchasePageSizes

Const pastPurchaseProducts

  • pastPurchaseProducts(state: State): object[]

Const pastPurchaseProductsBySku

  • pastPurchaseProductsBySku(state: State): object

Const pastPurchaseProductsWithMetadata

Const pastPurchaseQuery

  • pastPurchaseQuery(state: State): string

Const pastPurchaseSelectedRefinements

  • pastPurchaseSelectedRefinements(state: State): (SelectedValueRefinement | SelectedRangeRefinement)[]

Const pastPurchaseSiteParams

Const pastPurchaseSort

Const pastPurchaseSortSelected

Const pastPurchaseTemplate

Const pastPurchaseTotalPages

  • pastPurchaseTotalPages(state: State): number

Const pastPurchases

Const products

Const productsLoaded

  • productsLoaded(state: State): boolean

Const productsWithMetadata

Const productsWithPastPurchase

  • productsWithPastPurchase(state: State, idField: string): object[]

Const query

  • query(state: State): string

Const rangeNavigationMax

  • rangeNavigationMax(state: State, navigationId: any): number

Const rangeNavigationMin

  • rangeNavigationMin(state: State, navigationId: any): number

Const realTimeBiasesAllIds

Const realTimeBiasesById

Const realTimeBiasesHydrated

  • realTimeBiasesHydrated(state: State): any

Const recommendationsProducts

Const recordCount

  • recordCount(state: State): number

Const refinementCrumb

  • refinementCrumb(state: State, navigationId: string, index: number): object
  • Returns the refinement object for the given navigationId and index.

    Parameters

    • state: State
    • navigationId: string
    • index: number

    Returns object

    • field: string
    • high: any
    • low: any
    • range: boolean
    • value: any

Const relatedQueries

  • relatedQueries(state: State): string[]

Const route

  • route(state: State): string

Const saytPastPurchases

Const selectedRefinements

  • selectedRefinements(state: State): (SelectedValueRefinement | SelectedRangeRefinement)[]

Const siteParams

Const skip

  • skip(state: State, pagesize: number): number

Const sort

Const sortIndex

  • sortIndex(state: State): number

Const sorts

Const template

Const totalPages

  • totalPages(state: State): number

Const uiTagState

  • uiTagState(state: State, tagName: string, id: string): any

Const uiTagStates

  • uiTagStates(state: State, tagName: string): object

Const url

  • url(state: State): string

Const urlRequest

  • urlRequest(state: State): any

Generated using TypeDoc