Class CustomisationStepScreen

Represents a collection of generic steps (i.e. Assembly data or Kong steps), which are then listed as a collection of objects.

Hierarchy

CustomisationDataScreen
- CustomisationStepScreen

Implements

IUIElement<CustomisationStepScreenData>

Constructors

constructor

new CustomisationStepScreen(controller: CustomisationController): CustomisationStepScreen
Parameters
- controller: CustomisationController
Returns CustomisationStepScreen
Overrides CustomisationDataScreen.constructor
- Defined in js/modularconfig/ui/customisation/CustomisationStepScreen.tsx:20

Properties

`Protected` _content

_content: HTMLElement

`Protected` _controller

_controller: CustomisationController

`Protected` _data

_data: CustomisationStepScreenData

`Protected` _productCardUI

_productCardUI: ProductCardUI

`Protected` _root

_root: HTMLElement

`Protected` _rootClass

_rootClass: string

`Protected` _searchAndFilter

_searchAndFilter: SearchAndFilter

`Protected` _usesSearchAndFilter

_usesSearchAndFilter: boolean

Accessors

description

get description(): string
Returns string
Inherited from CustomisationDataScreen.description
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:34

element

get element(): HTMLElement
Returns HTMLElement
Implementation of IUIElement.element

Overrides CustomisationDataScreen.element
- Defined in js/modularconfig/ui/customisation/CustomisationStepScreen.tsx:24

rootClass

get rootClass(): string
Returns string
Inherited from CustomisationDataScreen.rootClass
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:38

searchAndFilter

get searchAndFilter(): SearchAndFilter
Returns SearchAndFilter
Inherited from CustomisationDataScreen.searchAndFilter
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:26

title

get title(): string
Returns string
Overrides CustomisationDataScreen.title
- Defined in js/modularconfig/ui/customisation/CustomisationStepScreen.tsx:28

Methods

destroy

destroy(): void
Destroy the UI entirely and eliminate all memory

Returns void
Implementation of IUIElement.destroy

Inherited from CustomisationDataScreen.destroy
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:104

getCurrentSearchTerm

getCurrentSearchTerm(): string
Returns string
Inherited from CustomisationDataScreen.getCurrentSearchTerm
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:73

hideFilters

hideFilters(): void
Returns void
Inherited from CustomisationDataScreen.hideFilters
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:123

onBackButtonClick

onBackButtonClick(): void
Returns void
Inherited from CustomisationDataScreen.onBackButtonClick
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:69

onExitCustomisation

onExitCustomisation(): void
Returns void
Inherited from CustomisationDataScreen.onExitCustomisation
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:65

onSizeUpdate

onSizeUpdate(data: ResponsivenessData): void
Automatically called whenever the size updates
Parameters
- data: ResponsivenessData
Returns void
Implementation of IUIElement.onSizeUpdate

Inherited from CustomisationDataScreen.onSizeUpdate
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:100

reset

reset(): void
Reset the UI to be re-used

Returns void
Implementation of IUIElement.reset

Overrides CustomisationDataScreen.reset
- Defined in js/modularconfig/ui/customisation/CustomisationStepScreen.tsx:67

resetOptions

resetOptions(): void
Returns void
Overrides CustomisationDataScreen.resetOptions
- Defined in js/modularconfig/ui/customisation/CustomisationStepScreen.tsx:63

searchCallback

searchCallback(query: string): Promise<SearchResult>
Parameters
- query: string
Returns Promise<SearchResult>
Inherited from CustomisationDataScreen.searchCallback
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:48

setCurrentOptions

setCurrentOptions(options: ICustomisationOptionData[]): void
Parameters
- options: ICustomisationOptionData[]
Returns void
Overrides CustomisationDataScreen.setCurrentOptions
- Defined in js/modularconfig/ui/customisation/CustomisationStepScreen.tsx:59

setData

setData(data: CustomisationStepScreenData): void
Parameters
- data: CustomisationStepScreenData
Returns void
Implementation of IUIElement.setData

Overrides CustomisationDataScreen.setData
- Defined in js/modularconfig/ui/customisation/CustomisationStepScreen.tsx:42

showFilters

showFilters(): void
Returns void
Inherited from CustomisationDataScreen.showFilters
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:126

`Protected` stepClicked

stepClicked(step: ICustomisationStepData): void
Parameters
- step: ICustomisationStepData
Returns void
- Defined in js/modularconfig/ui/customisation/CustomisationStepScreen.tsx:71

toggleClearFiltersButton

toggleClearFiltersButton(show: boolean): void
Parameters
- show: boolean
Returns void
Inherited from CustomisationDataScreen.toggleClearFiltersButton
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:129

toggleNoResultsElement

toggleNoResultsElement(show: boolean): void
Parameters
- show: boolean
Returns void
Inherited from CustomisationDataScreen.toggleNoResultsElement
- Defined in js/modularconfig/ui/customisation/CustomisationDataScreen.tsx:132

Class CustomisationStepScreen

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

controller: CustomisationController

Returns CustomisationStepScreen

Properties

Protected _content

Protected _controller

Protected _data

Protected _productCardUI

Protected _root

Protected _rootClass

Protected _searchAndFilter

Protected _usesSearchAndFilter

Accessors

description

Returns string

element

Returns HTMLElement

rootClass

Returns string

searchAndFilter

Returns SearchAndFilter

title

Returns string

Methods

buildInitialHtml

Returns HTMLElement

Protected buildStepHtml

Parameters

step: ICustomisationStepData

Returns HTMLElement

clearAllFilters

Returns void

clearFiltersElement

Returns void

clearUsedFiltersElement

Returns void

destroy

Returns void

getCurrentSearchTerm

Returns string

hideFilters

Returns void

onBackButtonClick

Returns void

onExitCustomisation

Returns void

onSizeUpdate

Parameters

data: ResponsivenessData

Returns void

reset

Returns void

resetOptions

Returns void

searchCallback

Parameters

query: string

Returns Promise<SearchResult>

setCurrentOptions

Parameters

options: ICustomisationOptionData[]

Returns void

setData

Parameters

data: CustomisationStepScreenData

Returns void

showFilters

Returns void

Protected stepClicked

Parameters

`Protected` _content

`Protected` _controller

`Protected` _data

`Protected` _productCardUI

`Protected` _root

`Protected` _rootClass

`Protected` _searchAndFilter

`Protected` _usesSearchAndFilter

`Protected` buildStepHtml

`Protected` stepClicked