1.8.1 • Published 2 years ago
@finastra/list v1.8.1
List
fds-list
extends Material Web mwc-list-base
, the package export three list items that can be used inside the fds-list
:
- fds-list-item
- fds-check-list-item
- fds-radio-list-item
Usage
APIs
See Material List for mor details.
Import
npm i @finastra/list
import '@finastra/list';
...
<fds-list>
<fds-list-item>Item 1</fds-list-item>
<fds-list-item>Item 2</fds-list-item>
</fds-list>
API
Properties
Property | Modifiers | Type | Default |
---|---|---|---|
activated | boolean | ||
disabled | boolean | ||
graphic | GraphicType | ||
group | string \| null | ||
hasMeta | boolean | ||
left | boolean | ||
multipleGraphics | boolean | ||
noninteractive | boolean | ||
ripple | Promise<Ripple \| null> | ||
selected | boolean | ||
styles | CSSResult[] | "styles","controlStyle" | |
tabindex | number | ||
text | readonly | string | |
twoline | boolean | ||
value | string |
Events
Event | Type |
---|---|
list-item-rendered | |
request-selected | RequestSelectedDetail |
fds-list-item
Properties
Property | Modifiers | Type | Default |
---|---|---|---|
activated | boolean | ||
disabled | boolean | ||
graphic | GraphicType | ||
group | string \| null | ||
hasMeta | boolean | ||
multipleGraphics | boolean | ||
noninteractive | boolean | ||
ripple | Promise<Ripple \| null> | ||
selected | boolean | ||
styles | CSSResult[] | "styles" | |
tabindex | number | ||
text | readonly | string | |
twoline | boolean | ||
value | string |
Events
Event | Type |
---|---|
list-item-rendered | |
request-selected | RequestSelectedDetail |
fds-list
Properties
Property | Attribute | Modifiers | Type | Default | Description |
---|---|---|---|---|---|
activatable | activatable | boolean | false | Sets activated attribute on selected items which provides a focus-persistent highlight. | |
debouncedLayout | (updateItems?: boolean \| undefined) => void \| undefined | ||||
emptyMessage | string \| undefined | ||||
index | readonly | MWCListIndex | |||
innerAriaLabel | string \| null | ||||
innerRole | string \| null | ||||
itemRoles | string \| null | ||||
items | readonly | ListItemBase[] | |||
itemsReady | Promise<never[]> | ||||
layout | (updateItems?: boolean \| undefined) => void | ||||
multi | multi | boolean | false | When true, enables selection of multiple items. | |
noninteractive | noninteractive | boolean | false | Disables focus and pointer events for the list item. | |
rootTabbable | boolean | ||||
selected | readonly | ListItemBase \| ListItemBase[] \| null | |||
styles | CSSResult[] | "styles" | |||
wrapFocus | boolean |
Methods
Method | Type |
---|---|
blur | (): void |
click | (): void |
focus | (): void |
focusItemAtIndex | (index: number): void |
getFocusedItemIndex | (): number |
layout | (updateItems?: boolean \| undefined): void |
renderPlaceholder | (): TemplateResult<1> \| null |
select | (index: MWCListIndex): void |
toggle | (index: number, force?: boolean \| undefined): void |
Events
Event | Type |
---|---|
action | ActionDetail |
items-updated | |
selected | SelectedDetail |
Slots
Name | Description |
---|---|
default | Content to display in the lists internal element. |
CSS Custom Properties
Property | Type | Default | Description |
---|---|---|---|
--fds-primary | color | "#694ED6" | Color of the select item. |
--fds-secondary | color | "#C137A2" | Color of the controls. |
fds-radio-list-item
Properties
Property | Modifiers | Type | Default |
---|---|---|---|
activated | boolean | ||
disabled | boolean | ||
graphic | GraphicType | ||
group | string \| null | ||
hasMeta | boolean | ||
left | boolean | ||
multipleGraphics | boolean | ||
noninteractive | boolean | ||
ripple | Promise<Ripple \| null> | ||
selected | boolean | ||
styles | CSSResult[] | "styles","controlStyle" | |
tabindex | number | ||
text | readonly | string | |
twoline | boolean | ||
value | string |
Events
Event | Type |
---|---|
list-item-rendered | |
request-selected | RequestSelectedDetail |
1.8.1
2 years ago
1.8.0
2 years ago
1.7.0
2 years ago
1.6.0
2 years ago
1.4.2
2 years ago
1.5.0
2 years ago
1.4.1
2 years ago
1.4.0
2 years ago
1.3.0
2 years ago
1.1.1
3 years ago
1.1.0
3 years ago
1.2.8
3 years ago
1.2.7
3 years ago
1.0.7
3 years ago
1.0.6
3 years ago
1.0.5
3 years ago
1.1.3
3 years ago
1.0.4
3 years ago
1.2.1
3 years ago
1.1.2
3 years ago
1.2.9
3 years ago
1.2.12
3 years ago
1.2.13
3 years ago
1.2.10
3 years ago
1.2.11
3 years ago
1.2.16
3 years ago
1.2.17
3 years ago
1.2.14
3 years ago
1.2.15
3 years ago
1.0.2
3 years ago
1.0.1
3 years ago
1.0.0
3 years ago
0.0.42
3 years ago
0.0.44
3 years ago
1.0.3
3 years ago
0.0.41
3 years ago
0.0.40
3 years ago
0.0.39
3 years ago
0.0.38
3 years ago
0.0.37
3 years ago