Class CustomisationController

Hierarchy

CustomisationController

Implements

IUIController<ICustomisationScreenData>

Constructors

constructor

new CustomisationController(delegate: IAppControllerDelegate, options: CustomisationControllerOptions, isGlobal?: boolean): CustomisationController
Parameters
- delegate: IAppControllerDelegate
- options: CustomisationControllerOptions
- isGlobal: boolean = false
Returns CustomisationController
- Defined in js/modularconfig/controllers/CustomisationController.ts:93

Properties

`Protected` _breadcrumbStack

_breadcrumbStack: MxtStack<IStackable>

`Protected` _configFilterController

_configFilterController: MxtConfiguratorFilterController

`Protected` _currentProducts

_currentProducts: {
id: string;
product: Product;
}[] = []

`Protected` _currentStep

_currentStep: ICustomisationStepData

`Protected` _enabled

_enabled: boolean

`Protected` _isGlobal

_isGlobal: boolean

`Protected` _menuLabel

_menuLabel: string

currentNotification

currentNotification: any

delegate

delegate: IAppControllerDelegate

`Protected` options

options: CustomisationControllerOptions

permanentId

permanentId: string = null

`Protected` titledPageController

titledPageController: TitledPageController

ui

ui: CustomisationUI

Accessors

currentProducts

get currentProducts(): readonly {
id: string;
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; };
}[]
Returns readonly {
id: string;
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/CustomisationController.ts:89

enabled

get enabled(): boolean
Returns boolean
- Defined in js/modularconfig/controllers/CustomisationController.ts:398

isGlobal

get isGlobal(): boolean
Returns boolean
- Defined in js/modularconfig/controllers/CustomisationController.ts:85

shouldShowBackButton

get shouldShowBackButton(): boolean
Returns boolean
- Defined in js/modularconfig/controllers/CustomisationController.ts:143

Methods

`Protected` _handleSearch

_handleSearch(query: string, screenData: CustomisationOptionScreenData): SearchResult
Parameters
- query: string
- screenData: CustomisationOptionScreenData
Returns SearchResult
- Defined in js/modularconfig/controllers/CustomisationController.ts:423

buildInitialHtml

buildInitialHtml(): HTMLElement
Returns HTMLElement
- Defined in js/modularconfig/controllers/CustomisationController.ts:118

clearAllFilters

clearAllFilters(): void
Returns void
- Defined in js/modularconfig/controllers/CustomisationController.ts:147

customise

customise(notificationData: any): Promise<void>
Parameters
- notificationData: any
Returns Promise<void>
- Defined in js/modularconfig/controllers/CustomisationController.ts:151

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/CustomisationController.ts:132

disable

disable(): void
Returns void
- Defined in js/modularconfig/controllers/CustomisationController.ts:407

enable

enable(): void
Returns void
- Defined in js/modularconfig/controllers/CustomisationController.ts:402

`Protected` generateAssemblyCustomisationStepData

generateAssemblyCustomisationStepData(data: StyleProductAssembly): Promise<AssemblyCustomisationStepData>
Parameters
- data: StyleProductAssembly
Returns Promise<AssemblyCustomisationStepData>
- Defined in js/modularconfig/controllers/CustomisationController.ts:522

`Protected` generateKongCustomisationStepData

generateKongCustomisationStepData(permanentId: string, data: MxtConfiguratorStep, controller: MxtConfiguratorController): Promise<KongCustomisationStepData>
Parameters
- permanentId: string
- data: MxtConfiguratorStep
- controller: MxtConfiguratorController
Returns Promise<KongCustomisationStepData>
- Defined in js/modularconfig/controllers/CustomisationController.ts:535

`Private` getBreadcrumbTrails

getBreadcrumbTrails(): string[]
Returns string[]
- Defined in js/modularconfig/controllers/CustomisationController.ts:385

handleSearch

handleSearch(query: string, screenData: ICustomisationScreenData): Promise<SearchResult>
Parameters
- query: string
- screenData: ICustomisationScreenData
Returns Promise<SearchResult>
- Defined in js/modularconfig/controllers/CustomisationController.ts:412

`Protected` onAssemblyCustomisationOptionClicked

onAssemblyCustomisationOptionClicked(step: AssemblyCustomisationStepData, optionData: ProductInfo): Promise<void>
Parameters
- step: AssemblyCustomisationStepData
- optionData: ProductInfo
Returns Promise<void>
- Defined in js/modularconfig/controllers/CustomisationController.ts:370

onBackButtonClick

onBackButtonClick(): void
Returns void
- Defined in js/modularconfig/controllers/CustomisationController.ts:394

onExitCustomisation

onExitCustomisation(): void
Returns void
- Defined in js/modularconfig/controllers/CustomisationController.ts:347

`Protected` onKongCustomisationOptionClicked

onKongCustomisationOptionClicked(step: KongCustomisationStepData, optionData: {}): Promise<void>
Parameters
- step: KongCustomisationStepData
- optionData: {}
Returns Promise<void>
- Defined in js/modularconfig/controllers/CustomisationController.ts:351

onNewProject

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

onOptionClicked

onOptionClicked(step: ICustomisationStepData, option: ICustomisationOptionData, screen: CustomisationOptionScreen): Promise<void>
Parameters
- step: ICustomisationStepData
- option: ICustomisationOptionData
- screen: CustomisationOptionScreen
Returns Promise<void>
- Defined in js/modularconfig/controllers/CustomisationController.ts:323

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/CustomisationController.ts:128

refresh

refresh(): void
Returns void
- Defined in js/modularconfig/controllers/CustomisationController.ts:112

`Protected` refreshCustomisation

refreshCustomisation(keepOptionsScreen?: boolean): Promise<void>
Parameters
- keepOptionsScreen: boolean = false
Returns Promise<void>
- Defined in js/modularconfig/controllers/CustomisationController.ts:591

reset

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

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

setMenuLabel

setMenuLabel(label: string): void
Parameters
- label: string
Returns void
- Defined in js/modularconfig/controllers/CustomisationController.ts:124

setupFilters

setupFilters(options: ICustomisationOptionData[], stepData: ICustomisationStepData): Promise<void>
Parameters
- options: ICustomisationOptionData[]
- stepData: ICustomisationStepData
Returns Promise<void>
- Defined in js/modularconfig/controllers/CustomisationController.ts:319

showNoCustomisation

showNoCustomisation(title: string, description: string): Promise<void>
Note that title does not show up in desktop UI, only in mobile
Parameters
- title: string
- description: string
Returns Promise<void>
- Defined in js/modularconfig/controllers/CustomisationController.ts:272

`Protected` updateKongCustomisationStepData

updateKongCustomisationStepData(data: KongCustomisationStepData): void
Parameters
- data: KongCustomisationStepData
Returns void
- Defined in js/modularconfig/controllers/CustomisationController.ts:570

updateSelectedStep

updateSelectedStep(stepData: ICustomisationStepData, refreshScreen?: boolean, screenData?: CustomisationOptionScreenData): Promise<void>
Parameters
- stepData: ICustomisationStepData
- refreshScreen: boolean = true
- screenData: CustomisationOptionScreenData = null
Returns Promise<void>
- Defined in js/modularconfig/controllers/CustomisationController.ts:292

Class CustomisationController

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

delegate: IAppControllerDelegate

options: CustomisationControllerOptions

isGlobal: boolean = false

Returns CustomisationController

Properties

Protected _breadcrumbStack

Protected _configFilterController

Protected _currentProducts

Protected _currentStep

Protected _enabled

Protected _isGlobal

Protected _menuLabel

currentNotification

delegate

Protected options

permanentId

Protected titledPageController

ui

Accessors

currentProducts

enabled

Returns boolean

isGlobal

Returns boolean

shouldShowBackButton

Returns boolean

Methods

Protected _handleSearch

Parameters

query: string

screenData: CustomisationOptionScreenData

Returns SearchResult

buildInitialHtml

Returns HTMLElement

clearAllFilters

Returns void

customise

Parameters

notificationData: any

Returns Promise<void>

destroy

Returns void

disable

Returns void

enable

Returns void

Protected generateAssemblyCustomisationStepData

Parameters

data: StyleProductAssembly

Returns Promise<AssemblyCustomisationStepData>

Protected generateKongCustomisationStepData

Parameters

permanentId: string

data: MxtConfiguratorStep

controller: MxtConfiguratorController

Returns Promise<KongCustomisationStepData>

Private getBreadcrumbTrails

Returns string[]

handleSearch

Parameters

query: string

screenData: ICustomisationScreenData

Returns Promise<SearchResult>

Protected onAssemblyCustomisationOptionClicked

Parameters

step: AssemblyCustomisationStepData

optionData: ProductInfo

Returns Promise<void>

onBackButtonClick

`Protected` _breadcrumbStack

`Protected` _configFilterController

`Protected` _currentProducts

`Protected` _currentStep

`Protected` _enabled

`Protected` _isGlobal

`Protected` _menuLabel

`Protected` options

`Protected` titledPageController

`Protected` _handleSearch

`Protected` generateAssemblyCustomisationStepData

`Protected` generateKongCustomisationStepData

`Private` getBreadcrumbTrails

`Protected` onAssemblyCustomisationOptionClicked

`Protected` onKongCustomisationOptionClicked

`Protected` refreshCustomisation

`Protected` updateKongCustomisationStepData