File

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

Description

The toolbar is an important component that allows to access needed data from the data items list faster and increase the usability.

Example :
<talenra-inbox-toolbar
  [disabledButtons]="disabledButtons"
  [checkedForm]="checkedForm"
  (iconBtn)="iconBtnFunction($event)"
></talenra-inbox-toolbar>

Implements

OnInit OnChanges OnDestroy

Metadata

Index

Properties
Methods
Inputs
Outputs
HostBindings
Accessors

Inputs

checkboxState
Type : CheckboxState
Default value : CheckboxState.Outline

Checkbox state of the toolbar checkbox.

disableBulkInteractionButtons
Type : boolean
Default value : false

Input to disable checkbox behavior and UI.

fixDisableDetailViewToggle
Type : boolean
Default value : false

Input to disable the detail view tab change button in the toolbar and set it to a fixed state. Used to set state if no data items are found.

numberMarkedDataItems
Type : number
Default value : 0

Number of marked data items.

refreshing
Type : boolean
Default value : false

Boolean to show if the data is to be refreshed.

Outputs

changePresetName
Type : EventEmitter<unknown>

EventEmitter to change preset name

checkboxStateChange
Type : EventEmitter<CheckboxState>

Emitter for the change in the checkbox state of the toolbar checkbox.

deletePreset
Type : EventEmitter<unknown>

EventEmitter to delete preset.

iconBtn
Type : EventEmitter<string>

EventEmitter for icon button clicks.

presetInteractions
Type : string

EventEmitter for the interactions with the preset.

resetPreset

Emitter to reset the preset to the default preset.

HostBindings

class.disableToolbarCheckboxClickInteractions
Type : any

HostBinding to disable the toolbar checkbox click interactions.

Methods

interactionActionMenuSubscriptions
interactionActionMenuSubscriptions(value: boolean)

Handles the opening of the action menu if accessed by a subscription.

Parameters :
Name Type Optional Description
value boolean No

The value of the subscription.

Returns : void
onActionsMenuClosed
onActionsMenuClosed()

Handles the closing of the action menu. Sets the value for the public api.

Returns : void
Public onCompressClick
onCompressClick(event: MouseEvent)

Click event emit that 'unfold-less' and 'unfold-more' icon will switch.

Parameters :
Name Type Optional Description
event MouseEvent No

Click event.

Returns : void
Public onDetailsClick
onDetailsClick(event: MouseEvent)

Click event emit that inbox detail view side panel will close.

Parameters :
Name Type Optional Description
event MouseEvent No

Click event.

Returns : void
Public onDownloadClick
onDownloadClick(event: MouseEvent)

Click event emit that a CSV can be downloaded.

Parameters :
Name Type Optional Description
event MouseEvent No

Click event.

Returns : void
Public onGetActionsClick
onGetActionsClick(mouseEvent?: MouseEvent, source?: string)

Click event emit that more actions can be seen.

Parameters :
Name Type Optional Description
mouseEvent MouseEvent Yes

The mouse event from the template.

source string Yes

The source of the click event.

Returns : void
onMenuOpen
onMenuOpen()

Focus the first focusable element in the menu when it is opened.

Returns : void
Public onOutsideCLick
onOutsideCLick()

Handles the click outside the component.

Returns : void
onRefreshClick
onRefreshClick()

Click event emit that the refresh btn is clicked.

Returns : void
Public onStartProcessClick
onStartProcessClick()

Click event emit that the process can start.

Returns : void
Public openConfigurationPanel
openConfigurationPanel(event: MouseEvent, tab: string)

Click event emit that attribute settings side panel will open.

Parameters :
Name Type Optional Description
event MouseEvent No

Click event.

tab string No

The tab to open.

Returns : void
openPresetSaveDialog
openPresetSaveDialog()

Open the preset save/overwrite dialog.

Returns : void
resetPresetToDefault
resetPresetToDefault()

Function to reset the preset to the default preset.

Returns : void

Properties

changedPresetValuesService
Type : unknown
Default value : inject(ChangedPresetValuesService)

The preset change service.

Public checkboxIndeterminate
Type : unknown
Default value : false

List style for the checkbox behavior and UI.

checkedForm
Type : FormGroup
Default value : new FormGroup({ check: new FormControl({ value: false, disabled: false }), })

Form for checkbox interaction.

condensedToolbarMenu
Type : unknown
Default value : () => {...}

Handles the click event of the condensed toolbar menu.

Parameters :
Name Description
toolbarAction

The menu component which is clicked.

dataItemsService
Type : unknown
Default value : inject(DataItemsService)

The data items service.

filterState
Type : unknown
Default value : inject(FilterStateService)

The inbox service.

filterToolbarService
Type : unknown
Default value : inject(FilterToolbarService)

The filter toolbar service.

inboxDetailViewService
Type : unknown
Default value : inject(InboxDetailViewService)

The inbox detail view service.

inboxState
Type : unknown
Default value : inject(InboxState)

The inbox service.

inboxToolbarService
Type : unknown
Default value : inject(InboxToolbarService)

The inbox toolbar service.

LINEBREAKWIDTH
Type : number
Default value : 659

The width of the line break setting.

talenraInboxToolbarMenuTrigger
Type : MenuAnchorDirective | undefined
Decorators :
@ViewChild('talenraInboxToolbarMenuTrigger', {read: MenuAnchorDirective})

Child of the toolbar menu.

toolbarWidth
Type : unknown
Default value : signal<number>(0)

Width of the toolbar. Used to show compressed or toolbar buttons into menu.

Accessors

isDisableToolbarCheckboxClickInteractions
getisDisableToolbarCheckboxClickInteractions()

HostBinding to disable the toolbar checkbox click interactions.

results matching ""

    No results matching ""