Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TableRowEditable<SuppliedDataType>

Type Parameters

  • SuppliedDataType = any

Hierarchy

  • TableRowEditable

Index

Properties

Methods

Properties

Optional idProperty

idProperty?: keyof SuppliedDataType

Unique value to track the row, very important. Editing will fail without a valid key.

Optional validators

validators?: ValidatorFn | ValidatorFn[]

List of validators run again the FormGroup created using the edit process

Methods

Optional allowDelete

  • allowDelete(row?: SuppliedDataType): boolean

  • Ability to allow a delete action after it's been triggered.

    Parameters

    • Optional row: SuppliedDataType

    Returns boolean

Optional delete

  • delete(row: SuppliedDataType): void

  • Callback when the delete icon is triggered

    Parameters

    • row: SuppliedDataType

    Returns void

Optional error

  • error(errors: { [ Property in string | number | symbol]: ValidationErrors }): void

  • Currently not integrated, will be once UI/UX team updates error states

    Parameters

    • errors: { [ Property in string | number | symbol]: ValidationErrors }

    Returns void

Optional rowIsDeletable

  • rowIsDeletable(row: SuppliedDataType): boolean

  • Toggle the disabled state of the delete button

    Parameters

    • row: SuppliedDataType

    Returns boolean

Optional rowIsEditable

  • rowIsEditable(row: SuppliedDataType): boolean

  • Toggle the disabled state of the edit button

    Parameters

    • row: SuppliedDataType

    Returns boolean

Optional update

  • update(row: SuppliedDataType): any

  • Callback when the row is valid and the update button is triggered

    Parameters

    • row: SuppliedDataType

    Returns any

Generated using TypeDoc