Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

🐛 Notable bugfixes

• Fixes a bug where removing an annotation from text would interfere with other annotations within that same block
• Fixes a bug where the correct version of a document did not appear when selected in the select revision menu
• CLI now supports an increased maximum dataset name length of up to 64 characters

📓 Full changelog

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

🐛 Notable bugfixes

• Fixes an issue that could cause the error "This document is of type X and cannot be edited as Y." when navigating between singleton documents

📓 Full changelog

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

🐛 Notable bugfixes

• Fixes a bug where if a space was configured as the default but not the first in the spaces array, the initial studio load would redirect to the correct URL but not configure the client to use the correct dataset.
• Fixes an edge case for user-defined components. All user-defined components are re-rendered on navigation regardless if the structure child is a function or not.
• Fixes an issue where user-defined components would not be hidden when pane was collapsed.
• Fixes sluggish UI in the image select dialog when the list contained large GIFs.
• Fixes image select dialog scrolling to top when loading a new page.
• Fixes an issue where deploying a GraphQL API might crash if schema-imported component tries to access localStorage.
• Fixes an issue where switching betweeen two "singletons" (document list items) without a defined schema type might result in the incorrect schema type being used.
• Fixes a styling issue in the @sanity/vision autocomplete styling.
• Fixes an earlier regression that caused the withDocument higher-order component to pass on the edited document before it was fully loaded.
• Fixes a bug where removing an annotation in the beginning of a Portable Text block would accidentally mutate trailing annotations inside that same block.

📓 Full changelog

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

🐛 Notable bugfixes

• Fixes a bug where the withDocument higher-order component would sometimes return null initially
• Fixes a bug where collapsed panes might not show their content when expanded
• Fixes a bug where tools would not get passed the tool property, resulting in incorrect context

📓 Full changelog

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

🐛 Notable bugfixes

• Fixes an issue that caused the GraphQL schema deployment to either be slow or hang on schemas with many references
• Fixes an error where the image and file inputs might throw an error about unsetting deep values on a primitive value
• Fixes glitches in logo animation when the studio is loading
• Fixes an issue where the desk tool would in certain cases give an error message saying Unknown document type *
• Fixes an issue where document list items inside of non-document lists would be rendered with "Untitled" as the title, instead of the full document preview
• Fixes an issue where the schema error summary would not be displayed because the studio would crash before being able to display it
• Fixes a regression that caused the withDocument higher-order component to get stuck on an initial null value
• Fixes an error where the client would fail to set up a listener when sending huge queries, without giving a developer-friendly error message

📓 Full changelog

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

🐛 Notable bugfixes

• Fixes UX issues with collapsing and expanding panes in the Desk Tool.
• Adds support for scrolling in the date picker‘s popover, when it’s not able to show all the contents at once.

📓 Full changelog

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

🐛 Notable bugfixes

• Fixes issue with experimental spaces not loading correctly (#2835)
• Fixes an issue with nested document lists. (#2834)
• Fixes an issue that would disallow deleting an unpublished document for users with access to update the draft
• Fixes an issue that would disable discarding drafts even for users that had access to it

📓 Full changelog

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

✨ Highlights

Fully migrated @sanity/default-layout to Sanity UI

The navbar and all of its elements have been migrated with @sanity/ui. The migration fixes a long-standing issue with responsiveness of the navbar, especially when it comes to the tool menu.

Fully migrated @sanity/desk-tool to Sanity UI

The pane system has been rewritten from scratch, and the UI of Desk Tool is completely refactored to using @sanity/ui.

Panes now support dynamic minimum and maximum widths, to provide a more responsive behavior.

Other features

• Newly initialized studios will now include a .gitignore
• Speed of dataset imports improved when assets already exists
• sanity hook commands updated to be forwards-compatible with upcoming webhook changes

🐛 Notable bugfixes

• fix(language-filter): fixes popover placement issue when language list is long (#2801)

📓 Full changelog

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

✨ Highlights

Specify API version for document lists

When declaring a custom structure for your desk tool navigation that includes document lists with custom filters, you can now specify which API version the filters use. This can be helpful for utilizing newer GROQ features such as geospatial queries, or in some cases for speeding up queries.

To use this feature, you can call the apiVersion() method:

// Restaurants in Oslo!
S.documentList()
  .title('Oslo restaurants')
  .apiVersion('v2021-06-07')
  .filter(`
    _type == $type &&
    geo::distance(
      location, // Location field
      geo::latLng($osloLat, $osloLng)
    ) < $threshold
  `)
  .params({
    type: 'restaurant',
    osloLat: 59.913,
    osloLng: 10.7522,
    threshold: 10000 // Meters
  })

More @sanity/ui migrations

The migration to our new UI framework continues, bringing improved visual consistency. In this release, the presence indicators and dashboard document previews are two of the pieces that is now fully migrated.

🐛 Notable bugfixes

• Fixes a deprecation warning being printed when running sanity start on node.js 16 or higher

📓 Full changelog

Upgrade Sanity Studio with:

sanity upgrade

🐛 Notable bugfixes

• Fixes a bug where the preview image for a document might overflow its container

📓 Full changelog

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

🐛 Notable bugfixes

• Fixes a bug that could in some rare cases trigger an error saying "Cannot read properties of null (reading 'expr')"

📓 Full changelog

Upgrade Sanity Studio with:

sanity upgrade

🐛 Notable bugfixes

• Fixes a bug where the sanity deploy and sanity build commands might crash after installing styled-components dependency interactively

📓 Full changelog

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

🐛 Notable bugfixes

• Fixes a bug where the sanity start commands might crash after installing styled-components dependency interactively
• Fixes a bug where the the Sanity CLI would crash on old versions of Node.js without giving a helpful message

📓 Full changelog

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

✨ Highlights

styled-components as first-level dependency

We've been hard at work migrating the internals of Sanity Studio from CSS modules Sanity UI, which is based on styled-components.

Over the past releases, we've seen a few reported issues where multiple versions of the styled-components dependency could end up in the same studio, causing issues that were hard to understand (sanity is undefined) and would require a full dependency tree reinstall to resolve (rm -rf node_modules && sanity install).

In this version, we're introducing styled-components as a first-level dependency in the studio, in the same way that react and react-dom is.

The first time you run sanity start, sanity build or sanity upgrade after the upgrade, you will be asked to install the dependency - and in non-interactive it will install automatically.

This migration should be seamless for most studios. We anticipate that in certain cases (custom monorepo setups, for instance) it might require manual changes, like adding styled-components as a dependency of the studio.

For a more in-depth look at the rationale behind this change, see the pull request for this change.

Specify API version for CLI query command

The sanity documents query CLI command now has a new flag: --api-version.

This is useful for testing how queries behave in different API versions. For now, the command will still use v1 as the default.

🐛 Notable bugfixes

• Fixes a rare case where an error could be thrown during the React render lifecycle without being an Error instance, which would crash the error boundary

📓 Full changelog

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

✨ Highlights

• Makes preview images clearer, especially on high-DPI devices
• Migrates @sanity/language-filter to Sanity UI
• Objects and arrays are now unset if they are empty
• Adds Java, Go, XML, C#, TSX, Ruby, and Yaml support to code input
• Migrates validation list to Sanity UI

🐛 Notable bugfixes

• Fixes bug introduced in v2.16.0 where inline Sanity references in Portable Text would not be saved properly.
• Fixes regression in portable text editor since 2.16.0 where blocks are re-rendered when they should not be.
• Validation markers will appear on nested fields if the containing field is marked as Rule.required().
• Fixes an issue causing object fields to not correctly run validation until dirtied #1713
• Fixes an issue with optional object fields with required subfields (nested objects, validation) #2630

📓 Full changelog

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

✨ Highlights

Removing warning for new fields in GraphQL schemas

If you add schema fields and run sanity graphql deploy you will no longer be warned about “dangerous changes.” Previously we followed the behavior of graphql.js, which treats added fields as “dangerous.” We have had a lot of feedback that in practice, this has been more bothersome than useful.

🐛 Notable bugfixes

• Since v2.16.0, (inline) references in Portable Text would not be saved properly and left an arbritrary attribute. This version fixes that.

📓 Full changelog

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

🐛 Notable bugfixes

• Fixes incorrect marker paths and focus issues in the validation list and form builder (#2713).
• Fixes new "Unable to resolve type for item" errors in validation (#2715)

📓 Full changelog

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

🔀 Introducing Conditional fields

A lot of you have been waiting for this for a while: A way to show and hide fields based on the value of some other field. The wait is over! In this release of the Sanity Studio the hidden field has been upgraded to take a callback function.

Example

export default {
 type: 'object',
 name: 'dropdownExample',
 fields: [
   {
     name: 'kind',
     type: 'string',
     options: {list: ['foo', 'bar', 'baz']},
   },
   {
     name: 'fooOptions',
     type: 'object',
     hidden: ({parent}) => !(parent?.kind === 'foo'),
     fields: [/* ... */],
   },
   {
     name: 'barOptions',
     type: 'number',
     hidden: ({parent}) => !(parent?.kind === 'bar'),
     fields: [/* ... */],
   },
 ],
}

Get more code examples and read more about the nitty gritty details in our docs.

🐛 Notable bugfixes

• Fixes an issue that would sometimes make image asset sources appear for files

📓 Full changelog

Upgrade Sanity Studio with:

sanity upgrade

🐛 Notable bugfixes

• Fixes issue where reference search might crash with a query error

📓 Full changelog

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

✨ Highlights

Custom asset source support for files (#2678)

This feature aligns the File field with the Image field by adding asset source support — allowing you to select existing assets in addition to uploading directly.

Adding custom asset sources for the File field follows the same pattern as the Image field, by adding a new part:

{
  "implements": "part:@sanity/form-builder/input/file/asset-sources",
  "path": "./parts/assetSources.js"
}

Other notable features

• Default locales for Google Maps (#2663). Thanks to @PetterRuud!
• Global and reference search now includes Portable Text fields (#2679)

🐛 Notable bugfixes

• Proper type exports for @sanity/desk-tool/structure-builder (#2687)

📓 Full changelog