@talenra/inbox documentation
  1. Injectables
  2. InboxToolbarService

File

src/lib/inbox-toolbar/inbox-toolbar.service.ts

Description

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

Import Information:

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

Index

Properties
Methods

Methods

Public setCheckboxState
setCheckboxState(state: CheckboxState)

Setter for the checkbox State.

Parameters :
Name Type Optional Description
state CheckboxState No

The state for the checkbox.
Returns : void
Public setConfigurationPanelState
setConfigurationPanelState(state: boolean)

Setter for configuration panel state.

Parameters :
Name Type Optional Description
state boolean No

The state of the configuration panel.
Returns : void
Public setSelectedItemsCount
setSelectedItemsCount(count: number)

Setter for the selected items count.

Parameters :
Name Type Optional Description
count number No

The number of selected items.
Returns : void

Properties

Public Readonly checkboxState$
Type : BehaviorSubject<CheckboxState>
Default value : new BehaviorSubject<CheckboxState>( CheckboxState.Outline )

The input is used to change the state of the toolbar checkbox. The input is an object of CheckboxState. If inputted the checkbox functionality of the default data items list gets disabled and the checkboxes are set to the state of the input. To activate the default checkboxes again, set the input to undefined.
Public Readonly selectedItemsCount$
Type : BehaviorSubject<number>
Default value : new BehaviorSubject<number>(-1)

Number of data items which are currently selected. Used to display the number of selected items in the toolbar as badge for the checkbox. The value overwrites the default badge value.

If default badge value should be used set the value to -1. The value is set to 0 if no items are selected. If the value is greater than 0 the badge is displayed with the value. If the value is greater than 1 the ellipsis and arrow buttons are enabled. If the value is greater than 99 the badge will display the value 99+.

results matching ""

    No results matching ""