@elemental/ui / Class

LmnListItemDirective

Decorators:@Directive
Selectors:[lmnListItem]
Implements:ControlValueAccessor

No documentation has been provided.

Properties

NameTypeDescription
active
r
Signal<boolean>
activeItem
r
Signal<any>
allowReordering
r
Signal<boolean>
checkMarkDisabled
r
Signal<boolean>

Whether the checkmark-enabled list item is disabled.

checkMarkVisible
r
Signal<boolean>

Whether the Checkmark for this specific List Item is visible, basing on its selection value.

controlDescriptionId
r
Signal<string>
controlId
r
Signal<string>

The dynamic unique IDs to be applied to the selection control, as well as to its label and description.

controlLabelId
r
Signal<string>
disabled
r
InputSignalWithTransform<boolean, unknown>

Whether the List Item is disabled. It does not apply to selection controls, whose disabled state needs to be conveyed through formControl/formGroup. For LISTBOX and SHEET Lists, however, setting this Input to true is equivalent to setting formControl/fromGroup as disabled, because for those Lists the activation of the entire List Item coincides with the selection/deselection of the control.

disabledMarker
r
InputSignal<string>

The disabled marker

disabledReason
r
InputSignal<string | undefined>

When the List Item is disabled by means of the disabled Input, it conveys the disabled reason to the user.

disabledReasonId
r
string
disableInfoButtonId
r
Signal<string>
disableInfoPopoverId
r
Signal<string>
formControl
r
FormControl<boolean | null>

The FormControl used internally by the List Item component to track the value and status changes of the selection controls.

formControlDisabled
r
Signal<boolean | undefined>

The current disabled status of the Form Control.

formControlValue
r
Signal<boolean | null | undefined>

The current value of the Form Control.

formGroup
r
Signal<LmnFormGroupDirective<unknown> | undefined>
id
r
InputSignal<string | undefined>

The id of the List Item. If not passed, a serial unique id is generated and applied to the host.

indeterminate
r
InputSignalWithTransform<boolean, string | boolean | undefined>

For multiple selection lists that use real selection controls (not checkmarks), it determines whether the checkbox contained in the List Item is in indeterminate state.

interactive
r
Signal<boolean>

Whether the List Item host is interactive.

isRoot
r
Signal<boolean>
isTitleLabel
r
Signal<boolean>

Whether the List Item title should be wrapped in a

listDepth
r
Signal<number>
listId
r
Signal<string>
listItemDisabled
r
Signal<boolean>

Whether the List Item host is disabled.

listItemId
r
Signal<string>

The ID of the List Item. If not set, it is inherited from the parent List or List Group.

listItemRole
r
Signal<string | undefined>

The List Item role. If a custom role is set, it is only applied when using the generic List selector (FREE mode). Otherwise, the default role is applied.

listItemValue
r
Signal<any>

The value of the List Item, useful to uniquely identify it and determine its activation/selection status. It defaults to the id.

mode
r
Signal<LmnListMode>
negative
r
Signal<boolean>
reason
r
Signal<string | undefined>
role
r
InputSignal<string | undefined>

Custom role. It is only applied when using the generic List selector (FREE mode).

selectionControlDisabled
r
Signal<boolean>

Whether the selection control, when it is real (not displayed as a checkmark), is disabled.

selectionControlDisabledReason
r
InputSignal<string | undefined>

When a real selection control is displayed (not checkmark) and that control is disabled, it conveys the disabled reason to the user.

selectionControlsPosition
r
Signal<LmnListSelectionControlsPosition>
selectionMode
r
Signal<LmnListSelectionMode>
selectionModeSupport
r
Signal<LmnListSelectionSupport>

The support for the currently selected Selection Mode, given the List Mode.

showCheckbox
r
Signal<boolean>

Whether Checkboxes should be displayed.

showCheckMark
r
Signal<boolean>

Whether Checkmarks should be displayed.

showDivider
r
Signal<boolean>

Whether to show the divider, basing on the setting inherited from the parent List or List Item Group, if existing.

showDividers
r
Signal<boolean>
showRadio
r
Signal<boolean>

Whether Radios should be displayed.

showSelectionEndSlot
r
Signal<boolean>

Whether the selection end slot should be displayed.

showSelectionStartSlot
r
Signal<boolean>

Whether the selection start slot should be displayed.

showToggle
r
Signal<boolean>

Whether Toggles should be displayed.

singleSelected
r
Signal<boolean>

Whether the list item of Tree or Listbox list is single selected.

sublists
r
Signal<readonly LmnListComponent[]>
trigger
r
OutputEmitterRef<LmnListItemTriggerEvent>

Emitted whenever a List Item that provides interaction is activated.

value
r
InputSignal<any>

For single selection lists, and for TABLIST and NAVIGATION lists, it is useful to uniquely identify a List Item and determine its activation/selection status. If not provided, it is inferred from the id.

Methods

getTextContent()

No documentation has been provided.

Presentation
getTextContent(): string;
Returns
string

onMultipleSelectionControlFocusOut()

No documentation has been provided.

Presentation
onMultipleSelectionControlFocusOut(): void;
Returns
void

requestToActivateItem()

No documentation has been provided.

Presentation
requestToActivateItem(activeItem: any): void;
Parameters
NameTypeDescription
activeItem
any
Returns
void

setParentListService()

No documentation has been provided.

Presentation
setParentListService(listService: LmnListService): void;
Parameters
NameTypeDescription
listService
LmnListService
Returns
void

updateListKeyManagerDefaultState()

No documentation has been provided.

Presentation
updateListKeyManagerDefaultState(): void;
Returns
void