orchardcore-admin-dashboard

Orchard Core Admin Dashboard - Prompt Templates

Create and Configure Dashboard Widgets

You are an Orchard Core expert. Generate admin dashboard widgets, content types, and template configurations for Orchard Core.

Guidelines

• Enable OrchardCore.AdminDashboard for admin dashboard widget support.
• Dashboard widgets are content items with the DashboardWidget stereotype.
• To create a widget content type, set its stereotype to DashboardWidget.
• DashboardPart is added automatically to every DashboardWidget type and stores Position, Width, and Height.
• Width and Height are unconstrained double grid-span values; the responsive dashboard layout determines how they render.
• ManageAdminDashboard permission is required to manage (add/edit/remove) widgets.
• AccessAdminDashboard permission is required for users without ManageAdminDashboard to view the dashboard.
• Users with only AccessAdminDashboard also need ViewContent or the applicable per-content-type view permission to see a widget.
• Customize widget appearance with templates named DashboardWidget-{ContentType}.DetailAdmin.cshtml.
• Always seal classes.

Enabling Admin Dashboard

{
  "steps": [
    {
      "name": "Feature",
      "enable": [
        "OrchardCore.AdminDashboard"
      ],
      "disable": []
    }
  ]
}

Widget Configuration Properties

Property	Type	Range	Description
Position	Numeric	Any	Controls the widget's order on the page. Lower values appear first.
Width	Double	Any	Grid-column span used by the responsive dashboard layout. The default is 1.0; Orchard Core does not enforce a fixed range.
Height	Double	Any	Grid-row span used by the responsive dashboard layout. The default is 1.0; Orchard Core does not enforce a fixed range.

Creating a Dashboard Widget Content Type via Recipe

{
  "steps": [
    {
      "name": "ContentDefinition",
      "ContentTypes": [
        {
          "Name": "{{WidgetTypeName}}",
          "DisplayName": "{{WidgetDisplayName}}",
          "Settings": {
            "ContentTypeSettings": {
              "Stereotype": "DashboardWidget",
              "Creatable": false,
              "Listable": false,
              "Draftable": true
            }
          },
          "ContentTypePartDefinitionRecords": [
            {
              "PartName": "TitlePart",
              "Name": "TitlePart",
              "Settings": {
                "ContentTypePartSettings": {
                  "Position": "0"
                }
              }
            },
            {
              "PartName": "HtmlBodyPart",
              "Name": "HtmlBodyPart",
              "Settings": {
                "ContentTypePartSettings": {
                  "Position": "1"
                }
              }
            }
          ]
        }
      ]
    }
  ]
}