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:18

Properties

`Protected` _content

_content: HTMLElement

`Protected` _controller

_controller: CustomisationController

`Protected` _data

_data: CustomisationStepScreenData

`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:35

element

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

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

rootClass

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

searchAndFilter

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

title

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

Methods

buildInitialHtml

buildInitialHtml(): HTMLElement
Returns HTMLElement
Implementation of IUIElement.buildInitialHtml

Overrides CustomisationDataScreen.buildInitialHtml
- Defined in js/modularconfig/ui/customisation/CustomisationStepScreen.tsx:30

`Protected` buildStepHtml

buildStepHtml(step: ICustomisationStepData): HTMLElement
Parameters
- step: ICustomisationStepData
Returns HTMLElement
- Defined in js/modularconfig/ui/customisation/CustomisationStepScreen.tsx:56

clearAllFilters

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

clearFiltersElement

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

clearUsedFiltersElement

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

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:105

getCurrentSearchTerm

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

hideFilters

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

onBackButtonClick

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

onExitCustomisation

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

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:101

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:48

resetOptions

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

searchCallback

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

setCurrentOptions

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

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:34

showFilters

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

`Protected` stepClicked

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

toggleClearFiltersButton

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

toggleNoResultsElement

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

Generated using TypeDoc