Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npm create sanity@latest

To upgrade a v3 Studio, run this command in its folder:

npm install sanity@latest

🐛 Notable bugfixes

• Fixes a potential crash in certain javascript environments when trying to access process.env
• Errors occuring during a migration now provides more details

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npm create sanity@latest

To upgrade a v3 Studio, run this command in its folder:

npm install sanity@latest

✨ Highlights

Array insert menu

This release includes a much requested upgrade of the array insert menu with various new options available. Including a new and more informative grid view, the ability to organize available schema types in groups, and filter them with a search term, and more. Check out the array article in the docs for examples.

Other features

Adds a type export of all the discovered Sanity schema variants resulting from running sanity typegen in the CLI. This can be useful in mocks/testing environments and used by third party tools to get a list of potential types. This union type is accessible as AllSanitySchemaTypes in the generated type definitions.

🐛 Notable bugfixes

• Fixes an issue where a text preview image would be included into the Portable Text Editor (PTE) when pasting text from Word.
• Fixes an issue where navigation options were not being passed as expected when calling a scoped router's navigate function.
• Fixes an issue where the PTE wouldn't activate when you start dragging files into it.
• Images in the Hotspot & Crop tool now render faster, and use far less memory.
• Reduces layout shift when uploading images that replace existing image assets.
• Fixes an issue that could cause a 409 error when restoring a document from history.
• Fixes an issue where image and file types might be listed in their lowercase variant in array insert menus

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npm create sanity@latest

To upgrade a v3 Studio, run this command in its folder:

npm install sanity@latest

🐛 Notable bugfixes

• Fixes a bug causing Structure Tool to crash when attempting to read the scrollTop of a nonexistent element.

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npm create sanity@latest

To upgrade a v3 Studio, run this command in its folder:

npm install sanity@latest

🐛 Notable bugfixes

• Fixes an issue where projects with a large amount of users would sometimes get a request error when loading user info.
• Form input components now have their own error boundaries, limiting crashes to a field level on a document form, instead of taking down the entire Structure Tool.
• Fixes React 19 causing the Portable Text Editor (PTE) to crash in some scenarios.
• Fixes an issue where searching for text within fields of type text (not string) would not yield results.
• Fixes an issue when dragging PTE blocks.
• Fixes a visual regression in PTE fullscreen mode where the Drop to upload files message would be positioned incorrectly.
• Fixes a regression where pasting from Word would insert an image version of the text being pasted instead of the actual text.

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npm create sanity@latest

To upgrade a v3 Studio, run this command in its folder:

npm install sanity@latest

✨ Highlights

• The studio initialization command now allows you to specify a package manager with a flag in a single line. This was previously only possible to do via an interactive CLI prompt. You can now skip this step:

npm create sanity@latest --package-manager pnpm

• The dryRun parameter is now available in the context provided for the defineMigration command available from sanity/migrate. This allows developers to write scripts that skip certain actions (for example, mutating external data stores) if it is only a dry run. An example might look like this:

import { defineMigration } from "sanity/migrate"

/**
 * Run this migration with
 * `npx sanity migration run my-migration`
 */
export default defineMigration({
  title: "my-migration",

  // pass whether the migration is a dry-run as context
  async *migrate(documents, { dryRun }) {
    for await (const document of documents()) {
      if(dryRun) {
        // Only log the effect
        console.log(`Something happened`)
      } else {
        // Execute the side-effect
        await thirdPartyRequest()
      }
      // ... do something with the document, maybe yield patches
    }
  },
})

🐛 Notable bugfixes

• Fixes an issue where image/file assets would not be listed in Structure lists, even if specified to do so.

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npm create sanity@latest

To upgrade a v3 Studio, run this command in its folder:

npm install sanity@latest

🐛 Notable bugfixes

Customizing restore action now works

This releases fixes a bug preventing developers removing or customising the "restore" document action using the document.actions Studio configuration property.

Studio will now respect changes you make to the "restore" document action, but please note that you must set the action property to "restore" on your DocumentActionComponent. The action property allows Studio to identify the restore action.

Example

import {RocketIcon} from '@sanity/icons'
import {type DocumentActionComponent} from 'sanity'

export const TestCustomRestoreAction: (
  action: DocumentActionComponent,
) => DocumentActionComponent = (restoreAction) => {
  const action: DocumentActionComponent = (props) => ({
    ...restoreAction(props),
    label: 'Custom restore',
    tone: 'positive',
    icon: RocketIcon,
  })

+ action.action = 'restore'
  return action
}

Other bugfixes

• Fixes an issue that could under certain conditions cause a circular structure to enter an infinite loop. Shoutout to @sarahsvedenborg and @stian-svedenborg for identifying the issue and proposing a fix.
• Resolves a type error caused by the missing preview property in DocumentComponents.
• Fixes an issue causing cross dataset reference search not returning hits in certain cases.
• Improves text selection of full screen Portable Text editors (PTE).
• Fixes issue where nested fullscreen PTEs were unable to open the block style dropdown.
• Fixes issue causing EXIF metadata not being included when uplading multiple images through drag + drop. Thanks @xuzuodong!
• Fixes bugs related to when the PTE is using a Reference input directly as the annotation type (not wrapped in a object type).
• Add automatically resolving of some validation errors in the PTE.
• Fixes bug causing "Untitled" to appear as title for array and object fields, even when explicitly passing undefined as title to renderDefault().

📓 Full changelog

Install or upgrade Sanity Studio

To initiate a new Sanity Studio project or upgrade an existing one, please refer to our comprehensive guide on Installing and Upgrading Sanity Studio.

If you are updating from a version earlier than 3.37.0, you should also check out this article to ensure your dependencies are up to date.

✨ Highlights

• The sanity init command for Next.js-embedded Studios is updated to install next-sanity v9 and next v14 as per best practices.
• Adds support for // @sanity-typegen-ignore comments that will ignore certain queries from type generation (thanks @largis21!).

🐛 Notable Bugfixes

• Fixes an issue where the scheduled publishing tool is displayed as the only available plugin when no other plugins are added.
• Adds memoization to minimize unnecessary calls to initial value functions, improving performance.
• Removes a circular reference to usePaneRouter that caused build warnings and potential execution order issues.
• Fixes bugs related to the Portable Text Input when using a Reference input directly as the annotation type. This change prohibits focus and unset on the root input, preventing abrupt modal closures and ensuring proper cleanup and function execution.

📓 Full changelog

Install or upgrade Sanity Studio

To initiate a new Sanity Studio project or upgrade an existing one, please refer to our comprehensive guide on Installing and Upgrading Sanity Studio.

If you are updating from a version earlier than 3.37.0, you should also check out this article to ensure your dependencies are up to date.

🐛 Notable bugfixes

• Fixes regression introduced in v3.42.0 that crashes the document list pane in Presentation Tool

📓 Full changelog

Install or upgrade Sanity Studio

To initiate a new Sanity Studio project or upgrade an existing one, please refer to our comprehensive guide on Installing and Upgrading Sanity Studio.

If you are updating from a version earlier than 3.37.0, you should also check out this article to ensure your dependencies are up to date.

✨ Highlights

Save Vision Query Results

You can now conveniently save the results of your Sanity Vision queries as JSON or CSV files. Simply run your query and click on the new "save result as" buttons in the bottom right corner.

Custom Components with Intent Handling in Structure Builder

Custom components included in the Structure Builder (like S.component(MyCustomComponent)) can now handle intents. This is especially useful for routing to custom components from global search results or other links. You can achieve this by using the canHandleIntent parameter.

S.listItem()
  .id('translate')
  .title('Translate Test')
  .child(S.component(TranslateExample).id('example')
    .canHandleIntent((intent, params, context) =>  {
      console.log(intent, params, context)
      return true
    }
  ))

🐛 Notable Bugfixes

• Fixes an issue where Boolean inputs were not always clearly indicated as read-only and disabled.
• Makes the search/filter in the document "Inspect" dialog case-insensitive.
• Prevents inputs within the Portable Text Editor from calling element.onFocus() on any opened block or inline-object, thus avoiding unintended modal closures.
• Prevents extra work on preview prepare functions, ensuring better performance.
• Fixes miscellaneous bugs and performance issues with Portable Text Editor's block extras and highlight rendering. For example, pointer events are now correctly disabled to avoid unnecessary cursor changes or rendering thrashes.
• Fixes an issue where the document history panel would appear to load indefinitely

📓 Full changelog

Install or upgrade Sanity Studio

To initiate a new Sanity Studio project or upgrade an existing one, please refer to our comprehensive guide on Installing and Upgrading Sanity Studio.

If you are updating from a version earlier than 3.37.0, you should also check out this article to ensure your dependencies are up to date.

🐛 Notable bugfixes

• Resolves a Maximum update depth exceeded crash in Presentation Tool.

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npm create sanity@latest

To upgrade a v3 Studio, run this command in its folder:

npm install sanity@latest

🐛 Notable bugfixes

• Fixes a regression in Presentation Tool introduced in v3.41.0 that causes it to crash in embedded studios.

📓 Full changelog

Install or upgrade Sanity Studio

To initiate a new Sanity Studio project or upgrade an existing one, please refer to our comprehensive guide on Installing and Upgrading Sanity Studio.

If you are updating from a version earlier than 3.37.0, you should also check out this article to ensure your dependencies are up to date.

✨ Highlights

• The Portable Text Editor (PTE) now supports drag-n-dropping + pasting of images and files into Image and File blocks.

🐛 Notable bugfixes

• Fixes a bug where importing a variable inside an imported file would fail in Typegen.
• Fixes issues in the PTE where tools would show as being active for a selection when only part of the selection used the tool. Now tools will show as active only when all highlighted selections use the tool.
• Fixes an Attempted import error related to using swr in embedded studios.
• Fixes an issue in which listeners would sometimes not close if they were unsubscribed from shortly after opening.
• Fixes an issue in which users were incorrectly seeing the scheduled publishing upsell UI.
• When child within the PTE is created without a _key, we now automatically create one for it, avoiding unnecessary warning.
• Fixes an issue in tasks in which the UI showed that they were created but the transaction didn't end.

📓 Full changelog

Install or upgrade Sanity Studio

To initiate a new Sanity Studio project or upgrade an existing one, please refer to our comprehensive guide on Installing and Upgrading Sanity Studio.

If you are updating from a version earlier than 3.37.0, you should also check out this article to ensure your dependencies are up to date.

✨ Highlights

Presence cursors in the Portable Text Editor

Sanity Studio has always supported real-time collaboration, but you have yet to be able to see where others are working within the Portable Text Editor. By upgrading, you'll get a similar experience to Google Docs when editing block content.

This release also includes bug fixes for the Portable Text Editor:

• The Portable Text Editor will now remove the invisible Stega-encoded characters if you copy-paste from a preview using Visual Editing
• The cursor will not move out of viewpoint when deleting a character in PTE.
• Creating an annotation at the bottom of a PTE will no longer scroll you to the top.
• Fixes an issue where changing positions of items of an array within PTE would launch a cryptic error

Comments and Tasks are now out of beta

Comments and Tasks are now officially out of beta; hence, we have updated the configuration APIs. Both comments and tasks are enabled by default and for all document types.

Comments configuration migration

Configuration during beta:

// ./sanity.config.ts|js

export default defineConfig({
  // ... rest of config
  document: {
    unstable_comments: {
      enabled: false,
    },
  },
});

New configuration (remove unstable_):

// ./sanity.config.ts|js

export default defineConfig({
  // ... rest of config
  document: {
-   unstable_comments: {
+   comments: {
      enabled: false,
    },
  },
});

Tasks configuration migration

Configuration during beta:

// ./sanity.config.ts|js

export default defineConfig({
  // ... rest of config
  unstable_tasks: { enabled: false },
})

New configuration (remove unstable_):

// ./sanity.config.ts|js

export default defineConfig({
  // ... rest of config
- unstable_tasks: { enabled: false },
+ tasks: { enabled: false },
})

Sanity TypeGen improvements

Thanks for all the feedback about Sanity TypeGen so far! This release ships several improvements and bug fixes:

• Sanity Typegen now supports count in GROQ projections
• TypeGen code (sanity.types.ts) is now formatted when a project has a Prettier configuration
• The TypeGen search path now includes src, app, and sanity folders by default
• Various bug fixes for type generation
• Fixes an issue where typegen command would fail on relative imports
• Fixes a bug where we could not extract or validate schema when the sanity-plugin-mux-input plugin was installed.

Do continue to give us feedback in #typescript in the community!

🐛 Notable bugfixes

• Fixes ambiguous aria-labels on some Status buttons
• Fixes issue with inline text comments that would include an inline object.
• Fixes toast message for document duplicate action

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npm create sanity@latest

To upgrade a v3 Studio, run this command in its folder:

npm install sanity@latest

🐛 Notable bugfixes

• Disables the new search API introduced in v3.38.0 due to a few discovered issues. We'll re-enable it in a future release.
• Fixes an issue when using the "movie database" template when running npm create sanity

📓 Full changelog

Install or upgrade Sanity Studio

To initiate a new Sanity Studio project or upgrade an existing one, please refer to our comprehensive guide on Installing and Upgrading Sanity Studio.

If you are updating from a version earlier than 3.37.0, you should also check out this article to ensure your dependencies are up to date.

✨ Highlights

Scheduled Publishing is now part of the core Sanity Studio package

The Scheduled Publishing feature, which up until this release has been available as a plugin for Sanity Studio, has been moved into the core sanity package and enabled by default. Scheduled Publishing is available on all paid plans and trials.

If you wish to opt out of Scheduled Publishing, you can do so in your Studio configuration:

// sanity.config.ts 
export default defineConfig({ 
   // ....
   scheduledPublishing: {
       enabled: false, 
     }
  )

Go to docs and feature announcement blog post to learn more.

Migrating from the Scheduled Publishing plugin to the new built-in configuration:

If you are already using Scheduled Publishing plugin, the first step is to get rid of it and update your studio to the latest release. If you already updated your studio you might have gotten an alert about this.

Run the following command in your project root to uninstall the plugin:

npm uninstall @sanity/scheduled-publishing

Next, remove the plugin from your studio configuration. Typically you'll find this in ./sanity.config.ts|js. Find the scheduledPublishing plugin and do the following changes in your configuration file:

Before:

// sanity.config.ts
import {scheduledPublishing} from '@sanity/scheduled-publishing'

export default defineConfig({
    //....
    plugins: [
      scheduledPublishing({
        // e.g. 12/25/2024 6:30 AM
        inputDateTimeFormat: 'MM/dd/yyyy h:mm a',
      })
    ]
})

After:

-  import {scheduledPublishing} from '@sanity/scheduled-publishing'


export default defineConfig({ 
    // ...
    plugins: [
-     scheduledPublishing({
-       inputDateTimeFormat: 'MM/dd/yyyy h:mm a',
-     })
    ],
+   scheduledPublishing: {
+       enabled: true,
+       inputDateTimeFormat: 'MM/dd/yyyy h:mm a',
+   }
})

🐛 Notable bugfixes

• Fixes a bug that caused negations to be transformed to wildcard search prefixes if they appeared at the end of a search query.
• Improves error handling when attempting to run a migration against invalid project configurations.
• Fixes an issue where a document's validation panel would show a system error message when a field with a validation error was deleted.
• Fixes a bug that caused _type to be incorrectly parsed from statements in the filter parameter of document lists.
• Fixes an issue that sometimes caused the Studio to load indefinitely when visited from a task notification email.

Installation and upgrading

Install

To initiate a new Studio without installing the CLI globally:

npm create sanity@latest

Upgrade

In most cases upgrading your studio is as straight-forward as installing the latest version:

npm install sanity@latest

For more information, visit the article on upgrading Sanity Studio in the docs.

If you are upgrading from a version earlier than 3.37.0, you also need to upgrade styled-components and @sanity/ui. To learn more, visit this help article on keeping dependencies up to date.

✨ Highlights

• Improved global search with better performance and new features.
• Custom styles are now displayed in the Portable Text Editor (PTE) style selector.

Enhanced Global Search

We've optimized the search functionality in the Studio for increased performance, especially in workspaces with large schemas. This improvement includes support for wildcard (*) and negation (-) tokens in search queries, allowing for more flexible and powerful search options. This enhanced search feature uses an internal API that is not yet documented for public use.

If you need to revert to the previous search behavior for any reason, you can disable the new search functionality by setting search.enableLegacySearch to true in your configuration.

🐛 Notable bugfixes

• Fixes a crash in the image hotspot and cropping tool within Next.js embedded Studios.
• Improves focus handling in PTE and the document pane.
• Fixes an edge case where PTE threw exceptions after resizing the validation panel.
• Fixes issue where annotations in PTE would incorrectly retain markup if all fields were null.
• Resolves an issue where custom sort orders, or sort orders in lists that are not documentTypeLists, would send invalid requests to the persistent user settings backend.
• Fixes regression that hid tool buttons when Sanity Studio was embedded in Next.js applications.
• Fixes a bug where the caret was not visible on code-formatted text within the PTE when using the dark scheme.
• Fixes an issue where the component for custom PTE styles was not being rendered in the style selector.
• Fixes an issue where copying strikethrough text from a google doc would remove the strikethrough once pasted in the PTE.
• Fixes tooltip text for the publish button to correctly display "yesterday" without the "ago" suffix when appropriate.

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npm create sanity@latest

We recommend that you check out the instructions for the Sanity Studio v3.37.0 release before upgrading. If you have already updated your dependencies as described in that document (i.e., you are updating from v3.37.0), you can proceed with updating your studio as normal:

To upgrade a v3 Studio, run this command in its folder:

npm install sanity@latest

🐛 Notable bugfixes

• Fixes an issue where sanity typegen generate would crash due to an incorrect babel configuration path
• Fixes an issue where sanity typegen generate would crash if the output directory did not exist

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npm create sanity@latest

We recommend that you check out the instructions for the Sanity Studio v3.37.0 release before upgrading. If you have already updated your dependencies as described in that document (I.e., you are updating from v3.37.0), you can proceed with updating your studio as normal:

npm install sanity@latest

🐛 Notable bugfixes

• Fixes a regression in v3.37.0 that affected embedded studios in certain environments and test runners
• Fixes an issue where newly created studios used an outdated version of styled-components

📓 Full changelog

⚠️ This upgrade requires [email protected] and @sanity/ui@2

This release comes with version requirements for the following packages:

• [email protected] (required for all Studio projects)
• @sanity/ui@2 (optional)

If you're maintaining a plugin for Sanity Studio, we recommend upgrading its dependencies too.

styled-components (required)

We have seen incompatibility issues when styled-components@5 is used outside of the Vite configuration that ships with sanity, for example, when the Studio is embedded in a Next.js or Remix project.

Styled Components is a required dependency for Sanity Studio projects. By upgrading it, you can also delete the @types/styled-components and react-is dependencies that were required with styled-components@5:

# npm
npm install sanity@latest styled-components@^6.1
npm rm @types/styled-components react-is

# pnpm

pnpm install sanity@latest styled-components@^6.1
pnpm rm @types/styled-components react-is

# yarn

yarn add sanity@latest styled-components@^6.1
yarn rm @types/styled-components react-is

Note: if you have local customizations in your Sanity Studio that are using styled-components you may need to make some minor adjustments to the customization code. For more details, please consult the styled-components migration guide.

@sanity/ui

Studio projects that use @sanity/ui for customizations and have it as a dependency in package.json needs to upgrade to @sanity/ui@2:

# npm
npm install "@sanity/ui@^2"

# pnpm
pnpm install "@sanity/ui@^2"

# yarn
yarn add "@sanity/ui@^2"

✨ Highlights

Tasks (Beta)

Sanity Studio now ships with Tasks. You can now:

• Target tasks for specific documents
• Assigned tasks to Studio members
• Comment on tasks, and use @-mentions
• Resolve tasks

Tasks ships enabled by default. If you want to disable tasks in your Studio, you can do so with this configuration:

// ./sanity.config.ts|js

export default defineConfig({
  // ... rest of config
	unstable_tasks: { enabled: false },
})

Learn more about Tasks in the documentation:

• Configuration
• User guide

Other features

• Resolves "Masquerading as CJS and ESM" type errors
• Adds ESM with .mjs exports for full support of Node.js' native ESM mode while still offering support for .esm.js exports for legacy bundlers
• Adds missing sideEffects: false conditions to package.json files, improving tree-shaking and reducing bundle sizes for embedded Sanity Studio projects
• Simplifies the Shopify schema starter template

🐛 Notable bugfixes

• Fixes a bug where wrongly formatted configuration would be inserted into tsconfig.json when sanity init was run inside of a Next.js project
• Fixes an issue where importing .scss or .sass files from the studio configuration or a descendant file would cause certain CLI commands to crash
• Improves error message when extracted schema (from sanity schema extract) could not be found when running sanity typegen generate
• Fixes an issue where the CLI might suggest deprecated Sanity v2 commands if you mistype a command name
• Makes the current field on slugs required when used with the --enforce-required-fields flag in sanity typegen contexts
• Fixes a bug where running npx sanity init in a Next.js project would break the tsconfig.json configuration

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npm create sanity@latest

To upgrade a v3 Studio, run this command in its folder:

npm install sanity@latest

🐛 Notable bugfixes

• Fixes an issue in the Portable Text editor in which annotations were not opening (bug introduced in v3.36.3)
• Fixes a potential cross-origin error from being shown in the developer console

📓 Full changelog