sanity-plugin-dashboard-widget-document-list

sanity-plugin-dashboard-widget-document-list

For the v2 version, please refer to the v2-branch.

What is it?

Dashboard widget for the Sanity Content Studio which displays a list of documents.

Install

npm install --save sanity-plugin-dashboard-widget-document-list

or

yarn add sanity-plugin-dashboard-widget-document-list

Ensure that you have followed install and usage instructions for @sanity/dashboard.

Usage

Add dashboard-widget-document-list as a widget to @sanity/dashboard plugin in sanity.config.ts (or .js):

import {dashboardTool} from '@sanity/dashboard'
import {documentListWidget} from 'sanity-plugin-dashboard-widget-document-list'

export default defineConfig({
  // ...
  plugins: [
    dashboardTool({
      widgets: [documentListWidget()],
    }),
  ],
})

Note: If a document in the result (as returned by the backend) has a draft, that draft is rendered instead of the published document.

Options

There are some options available, as specified by DocumentListConfig:

title (string)

Widget title

documentListWidget({
  title: 'Some documents',
})

order (string)

Field and direction to order by when docs are rendered

documentListWidget({
  title: 'Last edited',
  order: '_updatedAt desc',
})

limit (number)

Number of docs rendered

documentListWidget({
  title: 'Last edited',
  order: '_updatedAt desc',
  limit: 3,
})

types (array)

Array of strings signifying which document (schema) types are fetched

documentListWidget({
  title: 'Last edited',
  order: '_updatedAt desc',
  types: ['book', 'author'],
})

query (string) and params (object)

Customized GROQ query with params for maximum control. If you use the query option, the types, order, and limit options will cease to function. You're on your own.

documentListWidget({
  title: 'Published books by title',
  query: '*[_type == "book" && published == true] | order(title asc) [0...10]',
})

documentListWidget({
  title: 'My favorite documents',
  query: '*[_id in $ids]',
  params: {
    ids: ['ab2', 'c5z', '654'],
  },
})

createButtonText (string)

You can override the button default button text (Create new ${types[0]}) by setting createButtonText to a string of your choice. This doesn't support dynamic variables.

documentListWidget({
  title: 'Blog posts',
  query: '*[_type == "post"]',
  createButtonText: 'Create new blog post',
})

showCreateButton (boolean)

You can disable the create button altogether by passing a showCreateButton boolean:

documentListWidget({
  showCreateButton: false,
})

Widget size

You can change the width of the plugin using layout.width:

documentListWidget({
  layout: {width: 'small'},
})

License

MIT-licensed. See LICENSE.

Develop & test

This plugin uses @sanity/plugin-kit with default configuration for build & watch scripts.

See Testing a plugin in Sanity Studio on how to run this plugin with hotreload in the studio.

Release new version

Run "CI & Release" workflow. Make sure to select the main branch and check "Release new version".

Semantic release will only release on configured branches, so it is safe to run release on any branch.