@talenra/inbox documentation
  1. Injectables
  2. InboxState

File

src/lib/inbox/state/inbox.state.ts

Description

Provides control and state of the publicly available subjects of the inbox state.

Import Information:

  1. Not all attributes are changeable. Or should be changed (consult the api documentation).
Example :
import { InboxState } from '@talenra/inbox';

Index

Properties
Methods

Methods

Public setActionMenuExpanded
setActionMenuExpanded(isExpanded: boolean)

Opens or closes the action menu.

Parameters :
Name Type Optional Description
isExpanded boolean No

Whether the action-menu is expanded or not.
Returns : void
Public setInboxConfiguration
setInboxConfiguration(configuration: IInboxConfiguration)

Updates the inbox configuration.

Parameters :
Name Type Optional Description
configuration IInboxConfiguration No

The new inbox configuration.
Returns : void
Public setSelectedDataItemsList
setSelectedDataItemsList(selectedDataItems: any[])

Sets the selected data items in the data items list.

Parameters :
Name Type Optional Description
selectedDataItems any[] No

The selected data items.
Returns : void
Public setSelectedSidePanelTab
setSelectedSidePanelTab(tab: string)

Sets the selected side panel tab.

Parameters :
Name Type Optional Description
tab string No

The selected side panel tab.
Returns : void

Properties

Public Readonly actionMenuExpanded$
Type : unknown
Default value : new BehaviorSubject(false)

Provides whether the action menu (mat-menu) is expanded or not.
Public Readonly activeFilterSortSearch
Type : unknown
Default value : new BehaviorSubject<IFilterSortSearch>({ selectedMainAttributes: [], selectedDetailAttributes: [], filterAttributes: { identifier: 'head', rules: [], condition: QueryBuilderCondition.And, hierarchyLevel: 1, }, iconAttributes: [], searchText: '', sortAttributes: [], numberMainAttributesChosenByUser: 12, })

The active filters, sort and search information.
Public Readonly activePreset$
Type : unknown
Default value : new BehaviorSubject<IPreset>({} as IPreset)

Provides the active preset.
Public Readonly filteredDataItemsSubject$
Type : unknown
Default value : new BehaviorSubject<any[]>([])

Data items which are filtered and sorted.
Public Readonly inboxConfiguration$
Type : BehaviorSubject<IInboxConfiguration>
Default value : new BehaviorSubject({})

Provides the inbox configuration.
Public scrollToIndex
Type : number
Default value : 0

Value to what value is to be scrolled in the data-item-list
Public Readonly selectedAllAttributesSubject$
Type : unknown
Default value : new BehaviorSubject<IAttributeItem[]>([])

Provides all selected attributes.
Public Readonly selectedDataItemsList$
Type : unknown
Default value : new BehaviorSubject<any[]>([])

The selected data items in the data items list.
Public Readonly selectedDetailAttributesSubject$
Type : unknown
Default value : new BehaviorSubject<IAttributeItem[]>([])

Provides the selected detail attributes.
Public Readonly selectedMainAttributesSubject$
Type : unknown
Default value : new BehaviorSubject<IAttributeItem[]>([])

Provides the selected main attributes.

results matching ""

    No results matching ""