Class SearchAndBrowseController

Hierarchy

SearchAndBrowseController

Implements

IUIController<BrowseData>

Index

Constructors

Properties

_allFilters _allowNoResults _boundFilterListener _filterRouter _productFilterOptions _productFilters _rootMenu _useDisableClearAllFiltersState currentBreadcrumbs currentId currentProducts currentSearch filterListenerCallbacks menuRouter options productDataProvider productDetail renderController ui

Accessors

instanceId rootMenu

Constructors

constructor

new SearchAndBrowseController(renderController: RenderController, productDetail: ProductDetailController, options: SearchAndBrowseOptions): SearchAndBrowseController
Parameters
- renderController: RenderController
- productDetail: ProductDetailController
- options: SearchAndBrowseOptions
Returns SearchAndBrowseController
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:57

Properties

`Protected` _allFilters

_allFilters: Map<IFilter, string[]>

`Protected` _allowNoResults

_allowNoResults: boolean = true

`Protected` _boundFilterListener

_boundFilterListener: ((filteredProducts: ProductInfo[], allFitlers?: Map<IFilter, string[]>) => void)

Type declaration

- (filteredProducts: ProductInfo[], allFitlers?: Map<IFilter, string[]>): void
- Parameters
  - filteredProducts: ProductInfo[]
  - Optional allFitlers: Map<IFilter, string[]>
  Returns void

`Protected` _filterRouter

_filterRouter: FilterRouter

`Protected` _productFilterOptions

_productFilterOptions: Map<string, IFilter>

`Protected` _productFilters

_productFilters: IFilter[]

`Protected` _rootMenu

_rootMenu: Menu

`Protected` _useDisableClearAllFiltersState

_useDisableClearAllFiltersState: boolean = false

`Protected` currentBreadcrumbs

currentBreadcrumbs: (Menu | CategoryTree)[] = []

`Protected` currentId

currentId: string

`Protected` currentProducts

currentProducts: ProductInfo[]

`Protected` currentSearch

currentSearch: string

`Protected` filterListenerCallbacks

filterListenerCallbacks: ((filteredProducts: ProductInfo[], allFitlers?: Map<IFilter, string[]>) => void)[]

`Protected` menuRouter

menuRouter: MenuRouter = ...

`Protected` options

options: SearchAndBrowseOptions

`Protected` productDataProvider

productDataProvider: ProductDataProvider = ...

`Protected` productDetail

productDetail: ProductDetailController

`Protected` renderController

renderController: RenderController

ui

ui: SearchAndBrowseUI

Accessors

instanceId

get instanceId(): number
Returns number
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:78

rootMenu

get rootMenu(): Menu
Returns Menu
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:74

Methods

`Private` _addFilterOption

_addFilterOption(productFilter: IFilter, option: FilterOption, exclusive: boolean, dontAlertListeners: boolean): void
Parameters
- productFilter: IFilter
- option: FilterOption
- exclusive: boolean
- dontAlertListeners: boolean
Returns void
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:900

`Private` _alertListeners

_alertListeners(): void
Returns void
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:831

`Private` _clearAllFilterState

_clearAllFilterState(state: boolean): void
Parameters
- state: boolean
Returns void
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:950

`Private` _removeFilterOption

_removeFilterOption(productFilter: IFilter, option: FilterOption, dontAlertListeners: boolean): void
Parameters
- productFilter: IFilter
- option: FilterOption
- dontAlertListeners: boolean
Returns void
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:917

addFilterListener

addFilterListener(func: ((filteredProducts: ProductInfo[], allFitlers?: Map<IFilter, string[]>) => void)): void
Parameters
- func: ((filteredProducts: ProductInfo[], allFitlers?: Map<IFilter, string[]>) => void)
  - - (filteredProducts: ProductInfo[], allFitlers?: Map<IFilter, string[]>): void
    - Parameters
      
      filteredProducts: ProductInfo[]
      
      Optional allFitlers: Map<IFilter, string[]>
      
      Returns void
Returns void
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:693

`Private` collapseFilters

collapseFilters(filter: IFilter): void
Parameters
- filter: IFilter
Returns void
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:956

`Protected` createBrowseData

createBrowseData(option: Menu | CategoryTree): Promise<BrowseData>
Parameters
- option: Menu | CategoryTree
Returns Promise<BrowseData>
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:710

createDropDownFilter

createDropDownFilter(index: number, filter: Filter, distinctOptionIds: Set<any>, callbacks: FilterCallbacks): Promise<void>
Parameters
- index: number
- filter: Filter
- distinctOptionIds: Set<any>
- callbacks: FilterCallbacks
Returns Promise<void>
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:679

`Protected` createFilters

createFilters(filters: Filter[], distinctOptionIds: Set<any>, callbacks: FilterCallbacks): Promise<void>
Parameters
- filters: Filter[]
- distinctOptionIds: Set<any>
- callbacks: FilterCallbacks
Returns Promise<void>
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:665

`Protected` createUI

createUI(): void
Returns void
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:587

destroy

destroy(): void
Destroy means kill everything, does not make anything re-usable, this is purely for memory purposes

Returns void
Implementation of IUIController.destroy
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:86

`Protected` filterListener

filterListener(filteredProducts: ProductInfo[]): Promise<void>
Parameters
- filteredProducts: ProductInfo[]
Returns Promise<void>
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:787

`Protected` getAvailabilityText

getAvailabilityText(product: Product): Promise<string>
Parameters
- product: Product
Returns Promise<string>
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:819

`Private` getCategories

getCategories(parentCategory: CategoryTree): Category[]
Parameters
- parentCategory: CategoryTree
Returns Category[]
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:573

`Protected` getCategoryImages

getCategoryImages(categories: CategoryTree[]): Promise<string[]>
Parameters
- categories: CategoryTree[]
Returns Promise<string[]>
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:706

`Private` getFormattedProductPrice

getFormattedProductPrice(product: Product): Promise<string>
Parameters
- product: Product
Returns Promise<string>
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:965

goToTop

goToTop(): Promise<void>
Returns Promise<void>
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:214

handleSearch

handleSearch(query: string): Promise<SearchResult>
Parameters
- query: string
Returns Promise<SearchResult>
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:275

hide

hide(): void
Returns void
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:107

loadInitialData

loadInitialData(): Promise<void>
Returns Promise<void>
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:236

`Private` naiveSearch

naiveSearch(allProducts: {
    availability: string;
    price: string;
    productInfo: { readonly product: { readonly sku?: string; readonly productId?: string; readonly clientProductId?: string; readonly name?: string; readonly description?: string; readonly price?: number; readonly clientId?: string; ... 43 more ...; readonly setCustomProductAssembly: (productAssemblies: ProductAssembly[]) => void; ...;
}[], query: string): {
    availability: string;
    price: string;
    productInfo: { readonly product: { readonly sku?: string; readonly productId?: string; readonly clientProductId?: string; readonly name?: string; readonly description?: string; readonly price?: number; readonly clientId?: string; ... 43 more ...; readonly setCustomProductAssembly: (productAssemblies: ProductAssembly[]) => void; ...;
}[]
Parameters
- allProducts: {
      availability: string;
      price: string;
      productInfo: { readonly product: { readonly sku?: string; readonly productId?: string; readonly clientProductId?: string; readonly name?: string; readonly description?: string; readonly price?: number; readonly clientId?: string; ... 43 more ...; readonly setCustomProductAssembly: (productAssemblies: ProductAssembly[]) => void; ...;
  }[]
- query: string
Returns {
    availability: string;
    price: string;
    productInfo: { readonly product: { readonly sku?: string; readonly productId?: string; readonly clientProductId?: string; readonly name?: string; readonly description?: string; readonly price?: number; readonly clientId?: string; ... 43 more ...; readonly setCustomProductAssembly: (productAssemblies: ProductAssembly[]) => void; ...;
}[]
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:412

onBackButtonClick

onBackButtonClick(): Promise<void>
Returns Promise<void>
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:207

onBrowseableOptionClick

onBrowseableOptionClick(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:161

onNewProject

onNewProject(): Promise<void>
Returns Promise<void>
Implementation of IUIController.onNewProject
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:977

onProductClick

onProductClick(productId: string): Promise<void>
Parameters
- productId: string
Returns Promise<void>
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:122

onProductDetailClick

onProductDetailClick(productId: string): Promise<void>
Parameters
- productId: string
Returns Promise<void>
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:143

onRenderPlaceComplete

onRenderPlaceComplete(product: Product): void
Parameters
- product: Product
Returns void
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:93

onSizeUpdate

onSizeUpdate(data: ResponsivenessData): void
Called every time size updates, should generally call onSizeUpdate on its UI components
Parameters
- data: ResponsivenessData
Returns void
Implementation of IUIController.onSizeUpdate
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:82

`Private` rankedSearch

rankedSearch(allProducts: {
    availability: string;
    price: string;
    productInfo: { readonly product: { readonly sku?: string; readonly productId?: string; readonly clientProductId?: string; readonly name?: string; readonly description?: string; readonly price?: number; readonly clientId?: string; ... 43 more ...; readonly setCustomProductAssembly: (productAssemblies: ProductAssembly[]) => void; ...;
}[], query: any, internalMacSearch: boolean): {
    availability: string;
    price: string;
    productInfo: { readonly product: { readonly sku?: string; readonly productId?: string; readonly clientProductId?: string; readonly name?: string; readonly description?: string; readonly price?: number; readonly clientId?: string; ... 43 more ...; readonly setCustomProductAssembly: (productAssemblies: ProductAssembly[]) => void; ...;
}[]
Parameters
- allProducts: {
      availability: string;
      price: string;
      productInfo: { readonly product: { readonly sku?: string; readonly productId?: string; readonly clientProductId?: string; readonly name?: string; readonly description?: string; readonly price?: number; readonly clientId?: string; ... 43 more ...; readonly setCustomProductAssembly: (productAssemblies: ProductAssembly[]) => void; ...;
  }[]
- query: any
- internalMacSearch: boolean
Returns {
    availability: string;
    price: string;
    productInfo: { readonly product: { readonly sku?: string; readonly productId?: string; readonly clientProductId?: string; readonly name?: string; readonly description?: string; readonly price?: number; readonly clientId?: string; ... 43 more ...; readonly setCustomProductAssembly: (productAssemblies: ProductAssembly[]) => void; ...;
}[]
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:431

removeFilterListener

removeFilterListener(func: ((filteredProducts: ProductInfo[], allFitlers?: Map<IFilter, string[]>) => void)): void
Parameters
- func: ((filteredProducts: ProductInfo[], allFitlers?: Map<IFilter, string[]>) => void)
  - - (filteredProducts: ProductInfo[], allFitlers?: Map<IFilter, string[]>): void
    - Parameters
      
      filteredProducts: ProductInfo[]
      
      Optional allFitlers: Map<IFilter, string[]>
      
      Returns void
Returns void
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:697

reset

reset(): Promise<void>
Reset for re-use

Returns Promise<void>
Implementation of IUIController.reset
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:115

setMenuId

setMenuId(menuId: string): Promise<void>
Parameters
- menuId: string
Returns Promise<void>
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:240

`Protected` setProducts

setProducts(category: CategoryTree): Promise<void>
Parameters
- category: CategoryTree
Returns Promise<void>
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:637

`Protected` setupFilters

setupFilters(products: ProductInfo[]): Promise<void>
Parameters
- products: ProductInfo[]
Returns Promise<void>
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:591

`Protected` shouldShowBackButton

shouldShowBackButton(): boolean
Determines if the back button should be shown on the on the search and browse page or not

Returns
if the back button should be shown or not

Returns boolean
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:774

`Protected` shouldShowFilters

shouldShowFilters(): boolean
Determines if the back button should be shown on the on the search and browse page or not

Returns
if the back button should be shown or not

Returns boolean
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:783

show

show(): void
Returns void
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:111

`Protected` updateFromCurrentBreadcrumb

updateFromCurrentBreadcrumb(): Promise<void>
Returns Promise<void>
- Defined in js/modularconfig/controllers/SearchAndBrowseController.ts:221

Class SearchAndBrowseController

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

renderController: RenderController

productDetail: ProductDetailController

options: SearchAndBrowseOptions

Returns SearchAndBrowseController

Properties

Protected _allFilters

Protected _allowNoResults

Protected _boundFilterListener

Type declaration

Parameters

filteredProducts: ProductInfo[]

Optional allFitlers: Map<IFilter, string[]>

Returns void

Protected _filterRouter

Protected _productFilterOptions

Protected _productFilters

Protected _rootMenu

Protected _useDisableClearAllFiltersState

Protected currentBreadcrumbs

Protected currentId

Protected currentProducts

Protected currentSearch

Protected filterListenerCallbacks

Protected menuRouter

Protected options

Protected productDataProvider

Protected productDetail

Protected renderController

ui

Accessors

instanceId

Returns number

rootMenu

Returns Menu

Methods

Private _addFilterOption

Parameters

productFilter: IFilter

option: FilterOption

exclusive: boolean

dontAlertListeners: boolean

Returns void

Private _alertListeners

Returns void

Private _clearAllFilterState

Parameters

state: boolean

Returns void

Private _removeFilterOption

Parameters

productFilter: IFilter

option: FilterOption

dontAlertListeners: boolean

Returns void

addFilterListener

Parameters

func: ((filteredProducts: ProductInfo[], allFitlers?: Map<IFilter, string[]>) => void)

Parameters

filteredProducts: ProductInfo[]

Optional allFitlers: Map<IFilter, string[]>

Returns void

Returns void

buildInitialHtml

Returns void

cancelProductClick

Returns void

clearAllFilters

Returns void

Private collapseFilters

`Protected` _allFilters

`Protected` _allowNoResults

`Protected` _boundFilterListener

`Optional` allFitlers: Map<IFilter, string[]>

`Protected` _filterRouter

`Protected` _productFilterOptions

`Protected` _productFilters

`Protected` _rootMenu

`Protected` _useDisableClearAllFiltersState

`Protected` currentBreadcrumbs

`Protected` currentId

`Protected` currentProducts

`Protected` currentSearch

`Protected` filterListenerCallbacks

`Protected` menuRouter

`Protected` options

`Protected` productDataProvider

`Protected` productDetail

`Protected` renderController

`Private` _addFilterOption

`Private` _alertListeners

`Private` _clearAllFilterState

`Private` _removeFilterOption

`Optional` allFitlers: Map<IFilter, string[]>

`Private` collapseFilters

`Protected` createBrowseData

`Protected` createFilters

`Protected` createUI

`Protected` filterListener

`Protected` getAvailabilityText

`Private` getCategories

`Protected` getCategoryImages

`Private` getFormattedProductPrice

`Private` naiveSearch