Enhancements to OrderableDocumentList: Custom createIntent Handling &…

… menuItems injection (#75)

* feat: allow menuItems and create intent to be customized

* refactor: update README to include new usage

README.md

@@ -80,6 +80,8 @@ export default defineConfig({
               params: {
                 lang: 'en_US',
               },
+              createIntent: false, // do not add an option for item creation
+              menuItems: [], // allow an array of `S.menuItem()` to be injected to orderable document list menu
               // pass from the structure callback params above
               S,
               context,

src/desk-structure/orderableDocumentListDeskItem.ts

@@ -2,7 +2,7 @@ import {GenerateIcon, SortIcon} from '@sanity/icons'
 import type {ConfigContext} from 'sanity'
 
 import {ComponentType} from 'react'
-import {StructureBuilder, type ListItem} from 'sanity/desk'
+import {StructureBuilder, type ListItem, type MenuItem} from 'sanity/desk'
 import OrderableDocumentList from '../OrderableDocumentList'
 
 export interface OrderableListConfig {
@@ -12,6 +12,8 @@ export interface OrderableListConfig {
   icon?: ComponentType
   params?: Record<string, unknown>
   filter?: string
+  menuItems?: MenuItem[]
+  createIntent?: boolean
   context: ConfigContext
   S: StructureBuilder
 }
@@ -25,7 +27,7 @@ export function orderableDocumentListDeskItem(config: OrderableListConfig): List
     `)
   }
 
-  const {type, filter, params, title, icon, id, context, S} = config
+  const {type, filter, menuItems = [], createIntent, params, title, icon, id, context, S} = config
   const {schema, getClient} = context
   const client = getClient({apiVersion: '2021-09-01'})
 
@@ -34,6 +36,14 @@ export function orderableDocumentListDeskItem(config: OrderableListConfig): List
   const listIcon = icon ?? SortIcon
   const typeTitle = schema.get(type)?.title ?? type
 
+  if (createIntent !== false) {
+    menuItems.push(
+      S.menuItem()
+        .title(`Create new ${typeTitle}`)
+        .intent({type: 'create', params: {type}})
+        .serialize()
+    )
+  }
   return S.listItem()
     .title(listTitle)
     .id(listId)
@@ -49,10 +59,7 @@ export function orderableDocumentListDeskItem(config: OrderableListConfig): List
         component: OrderableDocumentList,
         options: {type, filter, params, client},
         menuItems: [
-          S.menuItem()
-            .title(`Create new ${typeTitle}`)
-            .intent({type: 'create', params: {type}})
-            .serialize(),
+          ...menuItems,
           S.menuItem().title(`Reset Order`).icon(GenerateIcon).action(`resetOrder`).serialize(),
           S.menuItem()
             .title(`Toggle Increments`)