Skip to main content

Class: CList<DataType, ListItemProps>

frontend.CList

Type parameters#

NameType
DataTypeDataType
ListItemPropsany

Hierarchy#

  • PureComponent<TCListProps<DataType, ListItemProps> & TCromwellBlockProps<TCList>>

    ↳ CList

Implements#

  • TCList<DataType, ListItemProps>

Table of contents#

Constructors#

Methods#

Constructors#

constructor#

• new CList<DataType, ListItemProps>(props)

Type parameters#

NameType
DataTypeDataType
ListItemPropsany

Parameters#

NameType
propsTCListProps<DataType, ListItemProps>

Overrides#

React.PureComponent<TCListProps<DataType, ListItemProps\> & TCromwellBlockProps<TCList\>\>.constructor

Defined in#

system/core/frontend/src/components/CList/CList.tsx:55

Methods#

addListener#

â–¸ addListener(type, cb, id?): void

Parameters#

NameType
type"componentDidUpdate"
cb() => void
id?string

Returns#

void

Implementation of#

TCList.addListener

Defined in#

system/core/frontend/src/components/CList/CList.tsx:93


clearState#

â–¸ clearState(): void

Returns#

void

Implementation of#

TCList.clearState

Defined in#

system/core/frontend/src/components/CList/CList.tsx:266


componentDidUpdate#

â–¸ componentDidUpdate(): void

Returns#

void

Overrides#

React.PureComponent.componentDidUpdate

Defined in#

system/core/frontend/src/components/CList/CList.tsx:69


componentWillUnmount#

â–¸ componentWillUnmount(): void

Returns#

void

Overrides#

React.PureComponent.componentWillUnmount

Defined in#

system/core/frontend/src/components/CList/CList.tsx:89


getPagedParams#

â–¸ getPagedParams(): TPagedParams<DataType>

Returns#

TPagedParams<DataType>

Implementation of#

TCList.getPagedParams

Defined in#

system/core/frontend/src/components/CList/CList.tsx:496


getProps#

â–¸ getProps(): TCListProps<DataType, ListItemProps>

Returns#

TCListProps<DataType, ListItemProps>

Implementation of#

TCList.getProps

Defined in#

system/core/frontend/src/components/CList/CList.tsx:60


getScrollboxEl#

â–¸ getScrollboxEl(): null | HTMLDivElement

Returns#

null | HTMLDivElement

Implementation of#

TCList.getScrollboxEl

Defined in#

system/core/frontend/src/components/CList/CList.tsx:457


init#

â–¸ init(): void

Returns#

void

Implementation of#

TCList.init

Defined in#

system/core/frontend/src/components/CList/CList.tsx:109


onPageScrolled#

â–¸ onPageScrolled(pageNumber): void

Parameters#

NameType
pageNumbernumber

Returns#

void

Defined in#

system/core/frontend/src/components/CList/CList.tsx:282


openPage#

â–¸ openPage(pageNumber): Promise<void>

Parameters#

NameType
pageNumbernumber

Returns#

Promise<void>

Implementation of#

TCList.openPage

Defined in#

system/core/frontend/src/components/CList/CList.tsx:292


render#

â–¸ render(): Element

Returns#

Element

Overrides#

React.PureComponent.render

Defined in#

system/core/frontend/src/components/CList/CList.tsx:499


setOverlay#

â–¸ setOverlay(isLoading, force?): void

Parameters#

NameType
isLoadingboolean
force?boolean

Returns#

void

Defined in#

system/core/frontend/src/components/CList/CList.tsx:394


setPagedParams#

â–¸ setPagedParams(val): TPagedParams<DataType>

Parameters#

NameType
valTPagedParams<DataType>

Returns#

TPagedParams<DataType>

Implementation of#

TCList.setPagedParams

Defined in#

system/core/frontend/src/components/CList/CList.tsx:497


setProps#

â–¸ setProps(props): void

Parameters#

NameType
propsnull | TCListProps<DataType, ListItemProps>

Returns#

void

Implementation of#

TCList.setProps

Defined in#

system/core/frontend/src/components/CList/CList.tsx:65


updateData#

â–¸ updateData(): Promise<void>

Returns#

Promise<void>

Implementation of#

TCList.updateData

Defined in#

system/core/frontend/src/components/CList/CList.tsx:134