Class SearchAndFilter

Hierarchy

SearchAndFilter

Implements

IUIElement<SearchAndFilterData>

Constructors

constructor

new SearchAndFilter(owner: ISearchAndFilterOwner): SearchAndFilter
Parameters
- owner: ISearchAndFilterOwner
Returns SearchAndFilter
- Defined in js/modularconfig/ui/SearchAndFilter.tsx:58

Properties

`Protected` _clearFiltersButton

_clearFiltersButton: HTMLElement

`Protected` _filtersButton

_filtersButton: HTMLButtonElement

`Protected` _filtersElement

_filtersElement: HTMLElement

`Protected` _filtersRoot

_filtersRoot: HTMLDivElement

`Protected` _noResultsElement

_noResultsElement: HTMLDivElement

`Protected` _owner

_owner: ISearchAndFilterOwner

`Protected` _root

_root: HTMLElement

`Protected` _searchInput

_searchInput: HTMLInputElement

`Protected` _searchTitle

_searchTitle: HTMLElement

`Protected` _suggestionsHeader

_suggestionsHeader: HTMLHeadingElement

`Protected` _usedFiltersElement

_usedFiltersElement: HTMLDivElement

Accessors

element

get element(): HTMLElement
Returns HTMLElement
Implementation of IUIElement.element
- Defined in js/modularconfig/ui/SearchAndFilter.tsx:62

filtersElement

get filtersElement(): HTMLElement
Returns HTMLElement
- Defined in js/modularconfig/ui/SearchAndFilter.tsx:86

usedFiltersElement

get usedFiltersElement(): HTMLElement
Returns HTMLElement
- Defined in js/modularconfig/ui/SearchAndFilter.tsx:82

Methods

buildInitialHtml

buildInitialHtml(): HTMLElement
Returns HTMLElement
Implementation of IUIElement.buildInitialHtml
- Defined in js/modularconfig/ui/SearchAndFilter.tsx:120

clearFiltersElement

clearFiltersElement(): void
Returns void
- Defined in js/modularconfig/ui/SearchAndFilter.tsx:257

clearSearch

clearSearch(): void
Returns void
- Defined in js/modularconfig/ui/SearchAndFilter.tsx:74

clearUsedFiltersElement

clearUsedFiltersElement(): void
Returns void
- Defined in js/modularconfig/ui/SearchAndFilter.tsx:296

currentSearchTerm

currentSearchTerm(): string
Returns string
- Defined in js/modularconfig/ui/SearchAndFilter.tsx:78

destroy

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

Returns void
Implementation of IUIElement.destroy
- Defined in js/modularconfig/ui/SearchAndFilter.tsx:234

handleSearch

handleSearch(query: string): Promise<void>
Parameters
- query: string
Returns Promise<void>
- Defined in js/modularconfig/ui/SearchAndFilter.tsx:90

hasUsedFilters

hasUsedFilters(): boolean
Returns boolean
- Defined in js/modularconfig/ui/SearchAndFilter.tsx:302

hide

hide(): void
Returns void
- Defined in js/modularconfig/ui/SearchAndFilter.tsx:66

hideFilters

hideFilters(): void
Returns void
- Defined in js/modularconfig/ui/SearchAndFilter.tsx:270

`Protected` onBackButtonClick

onBackButtonClick(): void
Returns void
- Defined in js/modularconfig/ui/SearchAndFilter.tsx:290

onSizeUpdate

onSizeUpdate(data: ResponsivenessData): void
Automatically called whenever the size updates
Parameters
- data: ResponsivenessData
Returns void
Implementation of IUIElement.onSizeUpdate
- Defined in js/modularconfig/ui/SearchAndFilter.tsx:230

reset

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

Returns void
Implementation of IUIElement.reset
- Defined in js/modularconfig/ui/SearchAndFilter.tsx:238

setData

setData(data: SearchAndFilterData): void
Parameters
- data: SearchAndFilterData
Returns void
Implementation of IUIElement.setData
- Defined in js/modularconfig/ui/SearchAndFilter.tsx:226

setSearchAndFilterState

setSearchAndFilterState(state: SearchAndFilterState): void
Parameters
- state: SearchAndFilterState
Returns void
- Defined in js/modularconfig/ui/SearchAndFilter.tsx:306

show

show(): void
Returns void
- Defined in js/modularconfig/ui/SearchAndFilter.tsx:70

showFilters

showFilters(): void
Returns void
- Defined in js/modularconfig/ui/SearchAndFilter.tsx:261

toggleClearFiltersButton

toggleClearFiltersButton(show: boolean): void
Parameters
- show: boolean
Returns void
- Defined in js/modularconfig/ui/SearchAndFilter.tsx:276

`Private` toggleElement

toggleElement(element: HTMLElement, show: boolean): void
Parameters
- element: HTMLElement
- show: boolean
Returns void
- Defined in js/modularconfig/ui/SearchAndFilter.tsx:280

toggleFiltersElement

toggleFiltersElement(show: boolean): void
Parameters
- show: boolean
Returns void
- Defined in js/modularconfig/ui/SearchAndFilter.tsx:253

toggleNoResultsElement

toggleNoResultsElement(show: boolean, query?: string): void
Parameters
- show: boolean
- Optional query: string
Returns void
- Defined in js/modularconfig/ui/SearchAndFilter.tsx:244

Generated using TypeDoc