# gd-user-dashboard



<!-- Auto Generated Below -->


## Properties

| Property          | Attribute           | Description                                                | Type                                                                 | Default     |
| ----------------- | ------------------- | ---------------------------------------------------------- | -------------------------------------------------------------------- | ----------- |
| `activeDatalist`  | --                  | an active datalist                                         | `{ description: string; url: string; historyItems: HistoryItem[]; }` | `undefined` |
| `items`           | --                  | dashboard list items                                       | `HistoryItem[]`                                                      | `null`      |
| `showDateHeaders` | `show-date-headers` | whether to split the history items by showing date headers | `boolean`                                                            | `true`      |
| `showShareButton` | `show-share-button` | if the share button should be visible or not               | `boolean`                                                            | `true`      |
| `tags`            | --                  | a list of tags to show in the filter by dropdown           | `HistoryItemTag[]`                                                   | `[]`        |


## Events

| Event                  | Description                                                                                  | Type                       |
| ---------------------- | -------------------------------------------------------------------------------------------- | -------------------------- |
| `activeListChanged`    | an event that is fired when the list changes, would be a good time to refresh the list       | `CustomEvent<string>`      |
| `cancelDatalistImport` | an event triggered when the user clicks cancel on the datalist import dialog                 | `CustomEvent<void>`        |
| `filterChanged`        | an event that is fired when the user selects a tag to filter by                              | `CustomEvent<string>`      |
| `saveHistoryItem`      | an event that is triggered to inform the application that a history item needs to be updated | `CustomEvent<HistoryItem>` |


## Methods

### `setActiveList(listType: DashboardListType) => Promise<void>`

an exposed method to change the visible list

#### Returns

Type: `Promise<void>`




## Dependencies

### Depends on

- [bs-nav](../bs-nav)
- [bs-nav-item](../bs-nav-item)
- [bs-icon](../bs-icon)
- [bs-form-row](../bs-form-row)
- [bs-form-group](../bs-form-group)
- [bs-form-label](../bs-form-label)
- [bs-form-control](../bs-form-control)
- [bs-button-group](../bs-button-group)
- [bs-button](../bs-button)
- [bs-list-group](../bs-list-group)
- [bs-spinner](../bs-spinner)
- [gd-user-dashboard-list-item](../gd-user-dashboard-list-item)
- [gd-user-dashboard-export-dialog](../gd-user-dashboard-export-dialog)
- [gd-user-dashboard-import-dialog](../gd-user-dashboard-import-dialog)
- [gd-user-dashboard-import-datalist-dialog](../gd-user-dashboard-import-datalist-dialog)
- [gd-user-dashboard-share-dialog](../gd-user-dashboard-share-dialog)
- [bs-modal](../bs-modal)
- [bs-modal-header](../bs-modal-header)
- [bs-modal-body](../bs-modal-body)
- [gd-tag-input](../gd-tag-input)
- [bs-modal-footer](../bs-modal-footer)

### Graph
```mermaid
graph TD;
  gd-user-dashboard --> bs-nav
  gd-user-dashboard --> bs-nav-item
  gd-user-dashboard --> bs-icon
  gd-user-dashboard --> bs-form-row
  gd-user-dashboard --> bs-form-group
  gd-user-dashboard --> bs-form-label
  gd-user-dashboard --> bs-form-control
  gd-user-dashboard --> bs-button-group
  gd-user-dashboard --> bs-button
  gd-user-dashboard --> bs-list-group
  gd-user-dashboard --> bs-spinner
  gd-user-dashboard --> gd-user-dashboard-list-item
  gd-user-dashboard --> gd-user-dashboard-export-dialog
  gd-user-dashboard --> gd-user-dashboard-import-dialog
  gd-user-dashboard --> gd-user-dashboard-import-datalist-dialog
  gd-user-dashboard --> gd-user-dashboard-share-dialog
  gd-user-dashboard --> bs-modal
  gd-user-dashboard --> bs-modal-header
  gd-user-dashboard --> bs-modal-body
  gd-user-dashboard --> gd-tag-input
  gd-user-dashboard --> bs-modal-footer
  bs-button --> bs-icon
  gd-user-dashboard-list-item --> bs-list-group-item
  gd-user-dashboard-list-item --> bs-form-check
  gd-user-dashboard-list-item --> bs-icon
  gd-user-dashboard-list-item --> gd-tag-input
  gd-user-dashboard-list-item --> bs-button
  gd-user-dashboard-export-dialog --> bs-modal
  gd-user-dashboard-export-dialog --> bs-modal-header
  gd-user-dashboard-export-dialog --> bs-modal-body
  gd-user-dashboard-export-dialog --> bs-form-row
  gd-user-dashboard-export-dialog --> bs-form-group
  gd-user-dashboard-export-dialog --> bs-form-label
  gd-user-dashboard-export-dialog --> bs-form-control
  gd-user-dashboard-export-dialog --> bs-modal-footer
  gd-user-dashboard-export-dialog --> bs-button
  gd-user-dashboard-export-dialog --> bs-spinner
  bs-modal --> bs-modal-dialog
  gd-user-dashboard-import-dialog --> bs-modal
  gd-user-dashboard-import-dialog --> bs-modal-header
  gd-user-dashboard-import-dialog --> bs-modal-body
  gd-user-dashboard-import-dialog --> bs-form-row
  gd-user-dashboard-import-dialog --> bs-form-group
  gd-user-dashboard-import-dialog --> bs-form-file
  gd-user-dashboard-import-dialog --> bs-modal-footer
  gd-user-dashboard-import-dialog --> bs-button
  gd-user-dashboard-import-dialog --> bs-spinner
  gd-user-dashboard-import-datalist-dialog --> bs-modal
  gd-user-dashboard-import-datalist-dialog --> bs-modal-header
  gd-user-dashboard-import-datalist-dialog --> bs-modal-body
  gd-user-dashboard-import-datalist-dialog --> bs-list-group
  gd-user-dashboard-import-datalist-dialog --> bs-list-group-item
  gd-user-dashboard-import-datalist-dialog --> bs-modal-footer
  gd-user-dashboard-import-datalist-dialog --> bs-button
  gd-user-dashboard-import-datalist-dialog --> bs-spinner
  gd-user-dashboard-share-dialog --> bs-modal
  gd-user-dashboard-share-dialog --> bs-modal-header
  gd-user-dashboard-share-dialog --> bs-modal-body
  gd-user-dashboard-share-dialog --> bs-form-row
  gd-user-dashboard-share-dialog --> bs-form-group
  gd-user-dashboard-share-dialog --> bs-form-label
  gd-user-dashboard-share-dialog --> bs-form-control
  gd-user-dashboard-share-dialog --> bs-modal-footer
  gd-user-dashboard-share-dialog --> bs-button
  gd-user-dashboard-share-dialog --> bs-spinner
  style gd-user-dashboard fill:#f9f,stroke:#333,stroke-width:4px
```

----------------------------------------------

*Built with [StencilJS](https://stenciljs.com/)*
