# gd-user-dashboard-list-item



<!-- Auto Generated Below -->


## Properties

| Property        | Attribute        | Description                                                                                                                                                                          | Type              | Default     |
| --------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------- | ----------- |
| `allowDelete`   | `allow-delete`   | if item should show delete button                                                                                                                                                    | `boolean`         | `true`      |
| `allowEdit`     | `allow-edit`     | if item should show edit button                                                                                                                                                      | `boolean`         | `false`     |
| `allowFavorite` | `allow-favorite` | if item should show favorite button                                                                                                                                                  | `boolean`         | `true`      |
| `alternateRow`  | `alternate-row`  | Is item odd or even entry in a list of items. Used to set alternating background colors for lists                                                                                    | `"even" \| "odd"` | `undefined` |
| `followUrl`     | `follow-url`     | if history item url is a valid url, clicking on it will immediately navigate to that url if set to false, the application will need to use the labelClick event to handle navigation | `boolean`         | `false`     |
| `item`          | --               | the history item to render                                                                                                                                                           | `HistoryItem`     | `undefined` |
| `selectable`    | `selectable`     | whether the item should be selectable (have a checkbox)                                                                                                                              | `boolean`         | `true`      |
| `selected`      | `selected`       | whether the item should be selected                                                                                                                                                  | `boolean`         | `false`     |
| `showSharedBy`  | `show-shared-by` | if item should show who shared it                                                                                                                                                    | `boolean`         | `false`     |


## Events

| Event          | Description                                                                                                                                                                                           | Type                                |
| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- |
| `deleteItem`   | used by the application to delete the history item                                                                                                                                                    | `CustomEvent<HistoryItem>`          |
| `editItem`     | used by the dashboard to handle editing a history item                                                                                                                                                | `CustomEvent<HistoryItem>`          |
| `itemSelected` | notifies the dashboard that this item has been selected                                                                                                                                               | `CustomEvent<HistoryItemSelection>` |
| `labelClick`   | the application can use the labelClick handler to customize user dashboard item clicks ex. if application stores JSON in history item URL field that represents a dialog to display instead of a page | `CustomEvent<HistoryItem>`          |
| `updateItem`   | used by the application to save changes that have been made to the history item                                                                                                                       | `CustomEvent<HistoryItem>`          |


## Dependencies

### Used by

 - [gd-user-dashboard](../gd-user-dashboard)

### Depends on

- bs-list-group-item
- bs-form-check
- bs-icon
- [gd-tag-input](../gd-tag-input)
- bs-button

### Graph
```mermaid
graph TD;
  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
  bs-button --> bs-icon
  gd-user-dashboard --> gd-user-dashboard-list-item
  style gd-user-dashboard-list-item fill:#f9f,stroke:#333,stroke-width:4px
```

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

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