sanity-plugin-document-reference-by
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

sanity-plugin-document-reference-by

This is a Sanity Studio v3 plugin.

With this plugin you can check document references

Example

Installation

npm install sanity-plugin-document-reference-by

Usage

Add it in deskStructure.js:

import {defineConfig} from 'sanity'
import {ReferencedBy} from 'sanity-plugin-document-reference-by'

export const defaultDocumentNodeResolver = (S) =>
  S.document().views([S.view.form(), S.view.component(ReferencedBy).title('Referenced by')])

and at sanity.config.js:

import { deskTool } from 'sanity/desk'
import deskStructure, { defaultDocumentNodeResolver } from './deskStructure'

export default defineConfig([
  {
    title: "title",
    name: "name",
    projectId: "projectId",
    dataset: "dataset",
    basePath: '/basePath',
    plugins: [
      deskTool({ structure: deskStructure, defaultDocumentNode: defaultDocumentNodeResolver }),
    ],
    ...
  }
])

License

MIT © Miguel Afonso

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.

Readme

Keywords

Package Sidebar

Install

npm i sanity-plugin-document-reference-by

Weekly Downloads

846

Version

1.0.1

License

MIT

Unpacked Size

17.4 kB

Total Files

12

Last publish

Collaborators

  • mr-afonso