Controlling document actions for a specific document

[chsko]

In Studio V2 you can set _experimental_actions to define what document actions should be available for a specific document. What is the V3 equivalent?

[p10e]

Hi @chsko, thanks for checking out v3 of the Studio! We generally recommend using Document Actions instead of __experimental_actions in both v2 (see also the Gotcha on this page) and v3. Here are documentation links for both versions:

• V2: https://www.sanity.io/docs/document-actions
• V3: https://beta.sanity.io/docs/platform/studio/v2-to-v3/document-actions-badges

Depending on your use case, you may also want to hide relevant document types in the "New Document"-structure, for example when using singleton documents. Here's another round of documentation links:

• V2: https://www.sanity.io/docs/initial-value-templates#56b4073ca73a
• V3: https://beta.sanity.io/docs/platform/studio/v2-to-v3/new-document-structure

Please let us know if anything is unclear or if you run into any issues!

[quirm]

This is a part of my config:

document: {
  actions: (prev) => {
    console.log(prev);
    return prev;
  },
  productionUrl,
},

On rc3 version prev returns an empty array for any document.

[dwkns]

@quirm There is an open issue for this exact problem. No word yet if it's a bug or they have changed the way it works.

[alexanderkalachev]

Still no clear explanation how to do simple things in V3, that worked perfectly with __experimental_actions:
– How to prevent creation of new singleton documents through "New document" button in a top bar?
– How to enable publication for changes in singleton, but preventing it for possible new documents of same type?

[quirm]

@alexanderkalachev this is what works for me:

export default defineConfig({
  ...,
  document: {
    actions: (prev, { schemaType }) => {
      // Allow only `delete`.
      if (schemaType === 'feedback') {
        return prev.filter((obj) => obj.action === 'delete');
      }

      // Allow only `publish` for page and settings documents (singletons).
      if (schemaType === 'page' || schemaType === 'settings') {
        return prev.filter((obj) => obj.action === 'publish');
      }

      // Allow everything for the rest of documents
      return prev;
    },
    newDocumentOptions: (prev /*, { creationContext }*/) => {
      // Remove singletons and feedback from "create new document"
      return prev.filter(
        (templateItem) => !['page', 'feedback', 'settings'].includes(templateItem.templateId)
      );
    },
  },
  ...
};

[alexanderkalachev]

@quirm Thank you! I figured out it.