1.1.0 • Published 5 months ago

@openenergytools/filterable-lists v1.1.0

Weekly downloads
-
License
Apache-2.0
Repository
-
Last release
5 months ago

\

This is a specialized list allowing you to selected and filter XML elements.

\

This is a specialized list allowing you to defined various kinds of actions on list items. When more than 2 additional actions are defined the actions 2 and following are grouped in a menu item.

Usage

This element was meant to be used only for plugins in this organization. If it still fills you bill please use or re-use it. But be aware that we will not react on feature wishes that do not contribute to the needs of plugin in this organization.

ActionList.ts:

class: ActionList, action-list

Superclass

NameModulePackage
FilterListBase/base-list.js

Static Fields

NamePrivacyTypeDefaultDescriptionInherited From
scopedElementsobject`{
'md-outlined-text-field': MdOutlinedTextField,
'md-icon': MdIcon,
'md-list': MdList,
'md-list-item': MdListItem,
'md-divider': MdDivider,
'md-menu': MdMenu,
'md-menu-item': MdMenuItem,

}` | | |

Fields

NamePrivacyTypeDefaultDescriptionInherited From
itemsActionItem[][]ListItems and potential
heightnumber72Height of each list item
filterablebooleanfalseWhether list items can be filtered on `headline` and `supportingText`FilterListBase
searchhelperstring'search'Placeholder for search input fieldFilterListBase

Fields

NamePrivacyTypeDefaultDescriptionInherited From
searchRegexprotectedRegExp/.*/iFilterListBase
searchInputprotectedTextField \| undefinedFilterListBase

Methods

NamePrivacyDescriptionParametersReturnInherited From
renderMoreVertItemprivateitem: ActionItemTemplateResult
renderActionItemprivateitem: ActionItem, indexTemplateResult
renderOtherActionsprivateTemplateResult
renderFirstActionprivateTemplateResult
renderActionsprivateTemplateResult
renderActionListItemprivateitem: ActionItemTemplateResult
renderListItemprivateitem: ActionItemTemplateResult
onFilterprotectedvoidFilterListBase
renderSearchFieldprotectedTemplateResultFilterListBase

Exports

KindNameDeclarationModulePackage
jsActionListActionListActionList.ts

SelectionList.ts:

class: SelectionList, selection-list

Superclass

NameModulePackage
FilterListBase/base-list.js

Static Fields

NamePrivacyTypeDefaultDescriptionInherited From
scopedElementsobject`{
'md-outlined-text-field': MdOutlinedTextField,
'md-icon': MdIcon,
'md-list': MdList,
'md-list-item': MdListItem,
'md-checkbox': MdCheckbox,

}` | | |

Fields

NamePrivacyTypeDefaultDescriptionInherited From
itemsSelectItem[][]
selectedElementsElement[]
filterablebooleanfalseWhether list items can be filtered on `headline` and `supportingText`FilterListBase
searchhelperstring'search'Placeholder for search input fieldFilterListBase

Fields

NamePrivacyTypeDefaultDescriptionInherited From
searchRegexprotectedRegExp/.*/iFilterListBase
searchInputprotectedTextField \| undefinedFilterListBase

Methods

NamePrivacyDescriptionParametersReturnInherited From
renderCheckboxListItemprivateitem: SelectItemTemplateResult
renderListItemprivateitem: SelectItemTemplateResult
onFilterprotectedvoidFilterListBase
renderSearchFieldprotectedTemplateResultFilterListBase

Exports

KindNameDeclarationModulePackage
jsSelectionListSelectionListSelectionList.ts

action-list.ts:

Exports

KindNameDeclarationModulePackage
custom-element-definitionaction-listActionList/ActionList.js

base-list.ts:

class: FilterListBase

Superclass

NameModulePackage
LitElementlit

Mixins

NameModulePackage
ScopedElementsMixin@open-wc/scoped-elements/lit-element.js

Fields

NamePrivacyTypeDefaultDescriptionInherited From
filterablebooleanfalseWhether list items can be filtered on `headline` and `supportingText`
searchhelperstring'search'Placeholder for search input field

Fields

NamePrivacyTypeDefaultDescriptionInherited From
searchRegexprotectedRegExp/.*/i
searchInputprotectedTextField \| undefined

Methods

NamePrivacyDescriptionParametersReturnInherited From
onFilterprotectedvoid
renderSearchFieldprotectedTemplateResult

Exports

KindNameDeclarationModulePackage
jsFilterListBaseFilterListBasebase-list.ts

selection-list.ts:

Exports

KindNameDeclarationModulePackage
custom-element-definitionselection-listSelectionList/SelectionList.js

© 2023 The Contributors