@talenra/inbox documentation
  1. Interfaces
  2. IDataItemId

File

src/lib/shared/interfaces/data-item-id.interface.ts

Description

Model to identify a data item with identifier (key of data item) and value. The identifier paired with the value is used to identify a specific data item.

When errorTitle is provided, the locked data item will display a clickable lock icon that opens an infotip with the error information.

Basic locked item (no error info - static lock icon)

Example :
import { IDataItemId } from '@talenra/inbox';

lockedItem: IDataItemId = {
  identifier: 'caseTypeName',
  value: '1234352',
};

Locked item with error info (clickable lock icon with infotip)

Example :
import { IDataItemId } from '@talenra/inbox';

lockedItemWithError: IDataItemId = {
  identifier: 'caseTypeName',
  value: '1234352',
  errorTitle: 'Validation Error',
  errorDescription: 'Line 1\nLine 2\nLine 3',  // Use \n for line breaks
};

Index

Properties

Properties

errorDescription
errorDescription: string
Type : string
Optional

Error description for displaying error messages in the infotip. Use \n (backslash-n) for line breaks, e.g., 'Line 1\nLine 2'.
errorTitle
errorTitle: string
Type : string
Optional

Error title for displaying error messages in the infotip.
identifier
identifier: string
Type : string

Identifier key of the data item attribute, which is used to identify specific data item.
value
value: string
Type : string

Value which is accessed by the identifier.

results matching ""

    No results matching ""