@sanity/dashboard

Dashboard

Dashboard is a Sanity Content Studio Tool which picks up and renders any widgets which implement part:@sanity/dashboard/widget. Install this plugin in your Studio to display stats about your project, recently edited documents, etc.

The Dashboard tool has been designed to be as generic as possible, making few assumptions about its widgets. The Dashboard itself is mostly concerned about the layout of the configured widgets.

Install

• cd to your Content Studio
• Type sanity install @sanity/dashboard. This will cause two things happen:
  • The Dashboard tool gets installed to ./node_modules in your Studio
  • @sanity/dashboard is appended to the plugins array in the sanity.json file of your Studio
• To verify that all is well, fire up your Studio (sanity start) and point your browser to http://localhost:3333/dashboard
• \o/

How to configure the Dashboard

Changing what is rendered on your Dashboard is easy. To take control, do the following:

• Implement your own dashboardConfig. In your sanity.json file, append the following line to the parts array:

{
  "implements": "part:@sanity/dashboard/config",
  "path": "src/dashboardConfig.js"
}

• Create the file src/dashboardConfig.js and make sure it's shaped something like this:

export default {
  widgets: [{name: 'sanity-tutorials'}, {name: 'project-info'}, {name: 'project-users'}]
}

The widgets array is how you tell the Dashboard which widgets to render. The ones mentioned in the above example are bundled with Sanity and require no separate installation.

• Restart your Studio and play around with the order of the widgets array in src/dashboardConfig.js. You can also duplicate them, should you want multiple instances of the same widget (see below).

A widget’s size behavior can be defined by adding a layout key to a the widget config. E.g.: {name: 'project-users', layout: {width: 'full', height: 'small'}}. Accepted values are auto, small, medium, large and full.

How to install a widget

Install a Dashboard widget as you would any other Sanity Studio plugin.

E.g. if you want to install the cats example widget mentioned below, proceed as follows:

• Type sanity install dashboard-widget-cats in your terminal (this works because it's published on npm under the name sanity-plugin-dashboard-widget-cats)
• Update your src/dashboardConfig.js file by adding {name: 'cats'} to the widgets array
• You've got 🐱 in your Studio

Some widgets allow options to change aspects of their behavior. If you install the document-list widget mentioned below, it can be configured with:

{name: 'document-list', options: {title: 'Last edited books', order: '_updatedAt desc', types: ['book']}}

Thus, if you want your dashboard to display both newest documents across all document types and another widget showing the last edited books, your dashboardConfig would look like this:

export default {
  widgets: [
    {name: 'document-list', options: {title: 'New', order: '_createdAt desc'}},
    {
      name: 'document-list',
      options: {title: 'Last edited books', order: '_updatedAt desc', types: ['book']}
    }
  ]
}

How to create a widget

Widgets are Sanity plugins that implement the part part:@sanity/dashboard/widget. Stay tuned for a complete "Widget Authors Cookbook", but until then, have a look at some sample widgets: E.g. A document List or maybe some cats?

When writing your widget components, it's recommended to use the DashboardWidget component from the Sanity Studio by importing it like so: import { DashboardWidget } from "@sanity/dashboard";.

This gives you a typical widget component structure with basic styles, and the option of presenting your content in the header, footer, or body of the widget.

If you need something more flexible you can create your own component.

Setting up the widget with the default setup will give you a basic widget that looks something like this:

<DashboardWidget
  header="A cat"
  footer={
    <Flex direction="column" align="stretch">
      <Button
        flex={1}
        paddingX={2}
        paddingY={4}
        mode="bleed"
        tone="primary"
        text="Get new cat"
      />
    </Flex>
  }
>
  <figure>
    <img src="https://placekitten.com/300/450" />
  </figure>
</DashboardWidget>

More examples

You can study the source code of these widgets to get a sense of how you can approach fetching of documents, adding configuration, and so on:

• dashboard-widget-document-list
• dashboard-widget-widget-document-count
• dashboard-widget-netlify