Options
All
  • Public
  • Public/Protected
  • All
Menu

The prop types for the WorkTray component.

Hierarchy

  • WorkTrayProps

Index

Properties

cancelWorkItem

cancelWorkItem: (workItemId: string) => boolean

Callback function used to cancel a work item. If this function returns true, the item will be removed from the work tray.

Type declaration

    • (workItemId: string): boolean
    • Parameters

      • workItemId: string

      Returns boolean

columns

columns: WorkTrayColumn[]

Array of WorkTrayColumn that defines the number of columns within the Work Tray

reassignWorkItem

reassignWorkItem: (workItemId: string) => boolean

Callback function used to reassign a work item to another user. If this function returns true, the item will be removed from the work tray.

Type declaration

    • (workItemId: string): boolean
    • Parameters

      • workItemId: string

      Returns boolean

rows

rows: WorkTrayRow[]

Array of WorkTrayRow that defines the number of rows within the Work Tray

searchWorkItems

searchWorkItems: (searchTerm: string) => void

Callback function used to pass a search query back to your API and update the data being passed to WorkTrayProps.rows

Type declaration

    • (searchTerm: string): void
    • Parameters

      • searchTerm: string

      Returns void

Generated using TypeDoc