Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 | 1x 18x 18x 18x 18x 18x 18x 30x 30x 30x 18x 4x 4x 18x 18x 18x 33x 33x 33x 33x 33x 4x 8x 29x 33x 15x 15x 63x 33x 18x | /**
* Copyright (c) Siemens 2016 - 2025
* SPDX-License-Identifier: MIT
*/
import { booleanAttribute, Component, computed, input, model, OnChanges } from '@angular/core';
import { FormsModule } from '@angular/forms';
import { Link } from '@siemens/element-ng/link';
import { SiSearchBarComponent } from '@siemens/element-ng/search-bar';
import { SiTranslateModule, t } from '@siemens/element-translate-ng/translate';
import { SiWidgetBaseComponent } from '../si-widget-base.component';
import { SiListWidgetItem, SiListWidgetItemComponent } from './si-list-widget-item.component';
/** Defines the sort order. */
export type SortOrder = 'ASC' | 'DSC';
/**
* The `<si-list-widget-body>` implements the body of the <si-list-widget> that can be
* used for composition within other components.
*/
@Component({
selector: 'si-list-widget-body',
imports: [SiListWidgetItemComponent, SiSearchBarComponent, SiTranslateModule, FormsModule],
templateUrl: './si-list-widget-body.component.html',
styleUrl: './si-list-widget-body.component.scss',
host: { class: '' }
})
export class SiListWidgetBodyComponent
extends SiWidgetBaseComponent<SiListWidgetItem[]>
implements OnChanges
{
/** Optional footer link for the list widget */
readonly link = input<Link>();
/**
* label for the "search placeholder" name
*
* @defaultValue
* ```
* t(() => $localize`:@@SI_LIST_WIDGET.SEARCH_PLACEHOLDER:Search...`)
* ```
*/
readonly searchPlaceholderLabel = input(
t(() => $localize`:@@SI_LIST_WIDGET.SEARCH_PLACEHOLDER:Search...`)
);
/**
* Enable ascending and descending SiListWidgetItem sorting. If enabled,
* items are initially ascending sorted.
*/
readonly sort = input<SortOrder>();
/**
* Enables the search functionality.
*
* @defaultValue false
*/
readonly search = input(false, { transform: booleanAttribute });
/**
* Compare function of for two `SiListWidgetItem`s that is used to sort
* the array of items. The default compares the item labels by using the
* string `localeCompare()` function.
*
* @param a - first `SiListWidgetItem` of the comparison.
*
* @param b - second `SiListWidgetItem` of the comparison.
*
* @returns A value `< 0` if `a` is smaller, `> 0` if `b` is smaller, otherwise `0`.
*
* @defaultValue
* ```
* (
* a: SiListWidgetItem,
* b: SiListWidgetItem
* ) => {
* const aLabel = typeof a.label === 'object' ? a.label.title! : a.label;
* const bLabel = typeof b.label === 'object' ? b.label.title! : b.label;
* return aLabel.localeCompare(bLabel);
* }
* ```
*/
readonly compareFn = input<(a: SiListWidgetItem, b: SiListWidgetItem) => number | undefined>(
(a: SiListWidgetItem, b: SiListWidgetItem) => {
const aLabel = typeof a.label === 'object' ? a.label.title! : a.label;
const bLabel = typeof b.label === 'object' ? b.label.title! : b.label;
return aLabel.localeCompare(bLabel);
}
);
/**
* Filter function that is used to filter down the list items when the user enters
* a term in the search bar. Default function.
*
* @param item - The item be checked if it matches the searchTerm.
*
* @param searchTerm - The string the user typed in the search bar.
*
* @returns `true` if the `searchTerm` matches the `item` and the `item` shall be kept in the list.
*
* @defaultValue
* ```
* (
* item: SiListWidgetItem,
* searchTerm: string
* ) => {
* const aLabel = typeof item.label === 'object' ? item.label.title! : item.label;
* return aLabel.toLowerCase().includes(searchTerm.toLowerCase());
* }
* ```
*/
readonly filterFn = input<(item: SiListWidgetItem, searchTerm: string) => boolean | undefined>(
(item: SiListWidgetItem, searchTerm: string) => {
const aLabel = typeof item.label === 'object' ? item.label.title! : item.label;
return aLabel.toLowerCase().includes(searchTerm.toLowerCase());
}
);
/**
* The number of skeleton progress indication rows.
*
* @defaultValue 6
*/
readonly numberOfLinks = input(6);
/** Used to display the defined number of ghost items */
protected readonly ghosts = computed(() => new Array(this.numberOfLinks() ?? 6));
/** Holds the list items that are displayed. May be filtered and sorted. */
protected readonly filteredListWidgetItems = computed(() => {
const value = this.value();
const sort = this.sort();
const searchText = this.searchText();
let filteredListWidgetItems: SiListWidgetItem[] | undefined = value;
if (searchText.length > 0) {
filteredListWidgetItems = value?.filter((item: SiListWidgetItem) =>
this.filterFn()(item, searchText)
);
} else {
filteredListWidgetItems = value ? [...value] : undefined;
}
if (sort) {
const factor = sort === 'ASC' ? 1 : -1;
filteredListWidgetItems = filteredListWidgetItems?.sort(
(a: SiListWidgetItem, b: SiListWidgetItem) => (this.compareFn()(a, b) ?? 0) * factor
);
}
return filteredListWidgetItems;
});
protected readonly searchText = model('');
}
|