Widget

Entity description

A dashboard widget is a customizable component that can be added to a dashboard to display information or functionality. Widgets are owned by specific applications and may require permissions or module feature flags (FF) to be visible for staff members.

Properties

Name	Description	Type	Example
uid	Unique identifier of the dashboardWidget object	string	`d290f1ee-6c54-4b01-90e6-d701748f0851`
app_code_name	The code name of the app that owns the widget	string	`myappcode`
display_name	The widget display name in different languages	object	`{ "en": "Payments", "fr": "Paiements" }`
permissions	The permissions required for the widget to show up for a staff member. If it is null, no restrictions will be enforced	array	`["payments_edit", "payments_read"]`
module	The module (FF) required for the widget to show up for a staff member	string	`Payments`
component_data	A configuration object is passed to the widget to initialize it. Can vary based on the widget class	object	`{ "name": "iFrame", "config": { "title": "calendar", "url": "www.partnerdomain.com/calendar" } }`
dimensions	The dimensions of the widget in grid units	object	See Dimensions table below
created_at	The time the staffWidgetsBoard was created	string	`2021-07-20T14:00:00.000Z`
updated_at	The time the staffWidgetsBoard was last updated	string	`2021-07-20T14:00:00.000Z`

Dimensions Properties

Name	Description	Type	Example
min_width	The minimum width of the widget in grid units	integer	`1`
min_height	The minimum height of the widget in grid units	integer	`1`
max_width	The maximum width of the widget in grid units	integer	`3`
max_height	The maximum height of the widget in grid units	integer	`2`
height	The default height of the widget	integer	`2`
width	The default width of the widget	integer	`2`

Example

{
  "uid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "app_code_name": "myappcode",
  "display_name": {
    "en": "Payments",
    "fr": "Paiements"
  },
  "permissions": ["payments_edit", "payments_read"],
  "module": "Payments",
  "dimensions": {
    "max_height": 2,
    "min_height": 1,
    "height": 2,
    "max_width": 3,
    "min_width": 1,
    "width": 2
  },
  "component_data": {
    "name": "iFrame",
    "config": {
      "title": "calendar",
      "url": "www.partnerdomain.com/calendar"
    }
  },
  "created_at": "2021-07-20T14:00:00.000Z",
  "updated_at": "2021-07-20T14:00:00.000Z"
}