SUPER Pane

The Sanity Desk Tool Pane with Super Powers

Status: ⚠️ MVP/EARLY ALPHA. There is much more (eventually) planned for this thing. Stay tuned/Watch Releases to be notifed with updates.

Please report bugs!

What

Super Pane aims to replace the traditional document type list pane in the Sanity Studio for certain documents that need more editing power. The goal of Super Pane is to enable more bulk editing and quick scanning while not losing any of the live-edit/reactivity of Sanity.

Super Pane aims to feel Sanity-y via @sanity/ui other integrations.

Installation

# note: the alpha tag is needed at this time
yarn add sanity-super-pane@alpha

Then integrate Super Pane using the structure builder:

import S from '@sanity/desk-tool/structure-builder';
import { createSuperPane } from 'sanity-super-pane';

export default () =>
  S.list()
    .title('Base')
    .items([
      S.listItem().title('Normal List').child(createSuperPane('movie', S)),
    ]);

Custom columns (optional):

The SuperPane supports custom queries and column cells. A custom column consists of a title, name and type. Optionally, you can prodide it with a query and/or custom compoment. Example is show in structure.js

Local development

Here is the first time setup for this lib:

Install

First, clone the repo (or a fork), and then install with npm

Note: installing with npm instead of yarn is required.

npm i

Create a sample project with the movie dataset

The login into the sanity CLI

npx sanity login

Then create a temporary project via the CLI. We'll use this create project entry in your Sanity account with the example movie dataset.

npx sanity init -y \
  --create-project "super-pane-dev" \
  --dataset production \
  --visibility private \
  --template moviedb \
  --output-path ./temp-movie-project

After this is done grab the project ID:

cat ./temp-movie-project/sanity.json | grep projectId

Copy and paste the projectId into the root sanity.json and then delete the temp-movie-project folder.

Start the dev server

npm start

Contributing

1. Open an issue first so we can quickly align on the what and how.
2. Fork this repo to your own Github account or org.
3. Create a new branch (e.g. feat/new-feature, fix/the-bug, etc) and commit following the Angular Commit Message Conventions. This is important because this repo is managed via semantic-release. Semantic-release parses these messages to determine version numbers.