Docebo libraries documentation site
vdevelop
Get Started
Guides
Overview Icons Illustrations Theme
Components
Accordion Avatar Badge Alert Badge Icon Badge Status Blank Slate Button Calendar Card Carousel Chip Data Browser Expandable Content Facet List
Filters
Filter Filter Container Filter Multiple Selection Filter Single Selection Filter Slider Range Selection Filter Slider Selection
Helper Message Icon Illustration
Inputs
Input Autocomplete Input Checkbox Input Checkbox Group Input Combobox Input Date Input Password Input Radio Group Input Rating Input Search Input Select Input Slider Input Text Input Toggle Input Upload
Link List List Listbox List Navigation List Presentation List Sheet List Tablist List Tree Menu Modal Dialog Navigation Notification Pagination Bar Popover Progress Skeleton Stepper Table Toast Tooltip
API References
@elemental/ui / Class

LmnListService

Decorators:@Injectable

No documentation has been provided.

Properties

NameTypeDescription
activeItem
r
Signal<any>

The value of the active List Item. It is only applied to Tablist and Navigation Lists, and only if they are root.

allowReordering
r
Signal<boolean>

Whether reordering the List Items in the current List is allowed. It is not inherited from the parent List.

id
r
Signal<string>

The ID of the List. It is not inherited from the parent List.

isRoot
r
Signal<boolean>

Whether the List is a Root List. If no #parentListService exists, then the List is a Root List regardless of the passed value.

listDepth
r
Signal<number>

Set the list depth.

mode
r
Signal<LmnListMode>

The List Mode. The getter function returns the validated List Mode (see documentation for the getListValidMode function).

negative
r
Signal<boolean>

Whether the List is negative. If not set, it is inherited from the parent List.

requestToActiveItem$
r
Observable<any>

An observable to request the activation of a specific List Item. Used to allow communication from the child List to Parent List.

role
r
Signal<string>

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

selectionControlsPosition
r
Signal<LmnListSelectionControlsPosition>

Whether to show the selection controls on the start or end edge of the List Items. If not set, it is inherited from the parent List.

selectionMode
r
Signal<LmnListSelectionMode>

The current selection mode for the List. It is not inherited from the parent List. The getter function returns the validated List Selection Mode, basing on the List Mode.

showDividers
r
Signal<boolean>

Whether to show the dividers between List Items. If not set, it is inherited from the parent List.

Accessors

get formGroup

The form group directive associated with the List.

Presentation
get formGroup(): LmnFormGroupDirective<unknown>;
Type

LmnFormGroupDirective<unknown>

set formGroup

No documentation has been provided.

Presentation
set formGroup(value: LmnFormGroupDirective<unknown>);
Type

LmnFormGroupDirective<unknown>

Methods

requestToActivateItem()

No documentation has been provided.

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

setActiveItem()

Set the active List Item value of the List.

Presentation
setActiveItem(activeItem: any): void;
Parameters
NameTypeDescription
activeItem
any

@param activeItem

Returns
void

setAllowReordering()

Set the allow reordering value of the List.

Presentation
setAllowReordering(allowReordering: boolean): void;
Parameters
NameTypeDescription
allowReordering
boolean

@param allowReordering

Returns
void

setId()

Set the ID of the List.

Presentation
setId(id: string): void;
Parameters
NameTypeDescription
id
string

@param id

Returns
void

setIsRoot()

Set the isRoot value of the List.

Presentation
setIsRoot(isRoot: boolean): void;
Parameters
NameTypeDescription
isRoot
boolean

@param isRoot

Returns
void

setMode()

Set the List Mode.

Presentation
setMode(mode: LmnListMode): void;
Parameters
NameTypeDescription
mode
LmnListMode

@param mode

Returns
void

setNegative()

Set the negative value of the List.

Presentation
setNegative(negative: boolean): void;
Parameters
NameTypeDescription
negative
boolean

@param negative

Returns
void

setRole()

The List depth. It is calculated basing on the value of isRoot:

  • If TRUE, the List depth is 0
  • If FALSE, the List depth is the parent List depth plus 1
Presentation
setRole(role: string): void;
Parameters
NameTypeDescription
role
string
Returns
void

setSelectionControlsPosition()

Set the selection controls position of the List.

Presentation
setSelectionControlsPosition(selectionControlsPosition: LmnListSelectionControlsPosition): void;
Parameters
NameTypeDescription
selectionControlsPosition
LmnListSelectionControlsPosition

@param selectionControlsPosition

Returns
void

setSelectionMode()

Set the selection mode of the List.

Presentation
setSelectionMode(selectionMode: LmnListSelectionMode): void;
Parameters
NameTypeDescription
selectionMode
LmnListSelectionMode

@param selectionMode

Returns
void

setShowDividers()

Set the show dividers value of the List.

Presentation
setShowDividers(showDividers: boolean): void;
Parameters
NameTypeDescription
showDividers
boolean

@param showDividers

Returns
void

updateListKeyManagerDefaultState()

Updates the default state of the ListKeyManager directive, in order for the first selected/active item to become the first to be focused the next time we enter the List.

Presentation
updateListKeyManagerDefaultState(): void;
Returns
void