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

• New Document inspector @beta API
• Document validation now opens in a sidepanel

🐛 Notable bugfixes

• Improves behavior of popovers in the Portable Text editor
• sanity debug now outputs all the roles of the currently authenticated user

📓 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 potential typing issues caused by mismatched versions of @types/react-is
• Fixes issue where validation tooltips were clipped inside of the Portable Text editor
• Improves accessibility of list panes when using screen readers

📓 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 issue where documents wasn't locked while a document was being synced
• Fixes a bug where certain references would result in invalid GraphQL union types (thanks @james2doyle!)

📓 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

Custom block, inlineBlock and annotation form components

Adds support for block, inlineBlock and annotation form components. You can now write plugins or create workspace configuration that change how these types are rendered in the studio

🐛 Notable bugfixes

• Fixes a regression that broke document-level readOnly
• Fixes a bug that caused conditional field callbacks inside fieldsets to get passed a wrong parent value
• Improves deep linking to the Portable Text Input for visual editing
• Fixes an issue where @sanity/block-tools would remove whitespace from <pre> tags
• Fixes an issue that could sometimes cause newly inserted array items to be immediately removed

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

🐛 Notable bugfixes and improvements

• Fixes an issue where change indicators were no longer showing up on boolean fields
• Adds document action custom dialog component
• Improves presence rendering performance
• Improves how focus and selection is handled and tracked in Portable Text fields
• Adds support for <sup>, <sub>, <ins> and <mark> in @sanity/block-tools
• Improves how image blocks in Portable Text fields are rendered for custom named image types

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

🐛 Notable bugfixes

• Fixes a recent regression from v3.11.2 where text annotations nested inside Portable Text inputs could not be edited properly

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

🐛 Notable bugfixes

• Fixes issue where image and file upload fields were not uploading data
• Fixes issue that would cause the dropdown list of autocomplete suggestions for reference fields to not overflow correctly inside the Portable Text editor
• Fixes issue where the current value of reference fields would not be displayed in the Portable Text editor
• Improves performance for arrays and portable text inputs

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

🐛 Notable bugfixes

• Fixes an issue causing field groups to be hidden if they only contain fieldsets

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

✨ Highlights

Document list search

It's now possible to search within document lists. We've also improved keyboard accessibility, making it much easier to navigate between lists and the document form editor itself.

🐛 Notable bugfixes

• Fixes issue where Edit intent links that opens the on-screen keyboard in iOS/android while also opening dialogs would break the layout
• Improves linking to single spans of text in the Portable Text Input
• Fixes a bug that made fields without a group appear in all groups
• Fixes a bug with the Portable Text Editor where single span texts could become out of sync with the server value
• Fixes an issue where an object field’s value is not unset when all object field values are empty

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

🐛 Notable bugfixes

• Fixes an issue where array inputs inside Portable Text dialogs would not properly render

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

🐛 Notable bugfixes

• Fixes issue where the Create new document dialog didn't work on smaller screens
• Fixes issue where out of range integers in number fields could crash the studio

📓 Full changelog

Installation and upgrading

Initiate a new Sanity Studio without installing the CLI globally:

npm create sanity@latest

To upgrade Sanity Studio, update its dependency:

npm install sanity@latest

✨ Highlights

Visual Editing (Enterprise Only)

Note

Visual Editing is available for select Sanity enterprise customers. If you would like to use Visual Editing with Vercel, you will also need to contact Vercel to enable this feature for your Vercel team. You may contact our sales team for more information.

This release includes support for Visual Editing and Content Source Maps. This feature enables you to make deep edit links from components in a front end that takes you to respective fields in the Studio. This enables a new workflow that substantially reduces the time it takes to make changes by bringing you directly to the relevant field where you can make edits reliably in its appropriate context. For more information on Visual Editing, check out the documentation here.

Visual Editing is available for mutual Sanity and Vercel Enterprise customers. Existing Sanity enterprise customers can contact their dedicated customer success manager to enable this feature. Customers interested in upgrading to an enterprise plan can contact our sales team for more information. You will also need to contact Vercel sales to enable this feature for your Vercel team.

Sanity enterprise customers can also use the Content Source Maps with GROQ to build custom Visual Editing capabilities. For more information, check out the Content Source Maps documentation here.

Quickly add Sanity Studio to Next.js

The sanity init command now recognizes if you are in a Next.js project, and will ask:

• What Sanity project you want to use (use existing or create new)
• Whether you want to place an embedded Studio using pages or app routes
• Whether you want to use TypeScript for your Studio
• What template you want to use (clean or blog)
• Whether you want to append the project ID and dataset to your .env file (you can also specify a custom env file with the --env flag)

If you have a Next.js project and want to quickly deploy an embedded Sanity Studio, you can run npx sanity init within your application's directory to get started.

Minimum version when using pnpm required: 8.x

Additional notable features

• Enables fully unattended studio init with CLI when projectId, dataset and --y flags are set
• sanity init will now determine default package manager choice based on currently running package manager

🐛 Notable bugfixes

• Updates the Shopify Studio template with various fixes
• Fixes an issue that caused field group buttons to steal focus when deep linking into a Studio value
• Fixes an issue causing focus to be set on wrong element when deep linking to a field inside an array
• Fixes an issue so deep linking to a field/input expands the right fieldsets/collapsed objects along the way
• Fixes an issue where validation errors would not focus on collapsed fieldset
• Fixes an issue where using pnpm to install dependencies would not install the latest available versions when creating a new project
• Resolves issue where unattended mode (--yes flag) for sanity init would still show a confirmation prompt about running a v2-like CLI command
• Fixes a bug with reference fields not receiving focus when clicking a validation error or following a link to the field
• Fixes intent links to focus on the correct location
• Fixes issue with pasting a file from clipboard into a file field that already has a value
• Fixes support for deep linking in image and file fields
• Fixes a bug that broke pasting a file into a file field when a value is already present

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npm create sanity@latest

To upgrade a Sanity Studio:

npm install sanity@latest

Improvements

• Add ability to use custom favicons - see https://www.sanity.io/docs/favicons for more information
• Improves document history performance
• Enables passing skipVisibilityCheck prop to preview components to avoid flickering when already in the viewport

🐛 Notable bugfixes

• Fixes virtualized list (arrays) not rendering properly when inside a modal
• Fixes bug where validation messages on Portable Text annotations were shown twice
• Improves wording on message shown after successfully deleting a document
• Fixes issue where unused references are cleared on clicking outside
• Resolves issue where validation errors are not focused when clicking on an error in the panel
• Fixes issue where annotation popovers were not scrollable in the Portable Text Editor
• Fixes a bug in the Portable Text Editor, which could lead to duplicating single sentence content with mixed marks in the editor when overwritten by another text
• Fixes an issue where creating a portable text annotation and inserting a value inside it would make a listening text editor crash
• Fixes an issue where documents would sometimes automatically scroll without user actually performing a scroll

📓 Full changelog

⚠️ THIS IS A MAINTENANCE RELEASE OF A PREVIOUS MAJOR VERSION OF SANITY

We recommend updating to Sanity Studio v3 which provides exceptional flexibility and an unparalleled developer experience. The core packages for Sanity Studio v2 will only receive critical bug fixes until Dec 7th, 2023

Please head over to the documentation for Sanity Studio v3 to learn more.

You can find migration guides from Studio v2 here.

Installation and upgrading

Upgrade Sanity Studio with:

sanity upgrade

🐛 Notable bugfixes

• Resolves an error that occurred when attempting to create a document of a certain type with an empty object as the initial value, resulting in a permission error

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade an existing Studio (v3):

npm install sanity@latest

✨ Highlights

New init flags: --bare, --env

The npm create sanity and sanity init CLI commands now have two new flags available:

• --bare - skips the installation of a Sanity Studio. Instead, it takes you through the project and dataset creation process and prints the project ID and dataset names to the console.
• --env [path] - detects the framework used in the current directory and creates a .env file with the correct prefix for environment variables. The path is optional; the default value is .env, but you can change it to anything beginning with .env, for example, .env.local.example.

These flags are useful when you want to integrate an application with a new or existing project, when you have some existing Studio code you want to set up, or when you only need the Content Lake capabilities.

Improved performance on large arrays

Lists of objects and references are now virtualized in the Sanity Studio UI. This should significantly improve performance in documents with large arrays.

Improvements for custom Vite configuration

Any custom Vite configuration defined in sanity.cli.ts will now be merged with the default configuration using Vite’s merge logic. This improvement will make it easier customize the Vite configuration without having to deeply understand the defaults. The configuration now also has improved TypeScript types.

Other features

• The schema validator now checks for fields that use the block type outside of an array, which is not currently supported (thanks @pauloborges!)

🐛 Notable bugfixes

• Resolves an error that occurred when attempting to create a document of a certain type with an empty object as the initial value, resulting in a permission error
• Addresses an issue where CSS files were not properly updated with a configured Studio base path
• Fixes a bug that caused the Studio to crash when trying to fetch user data without proper permissions
• Resolves a problem where multiple sorting options could be selected at the same time in a dropdown menu
• Addresses an issue where long filenames/MIME types were not truncated in the file picker list
• Resolves a bug that caused the Portable Text Editor to crash when encountering an invalid value.

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

🐛 Notable bugfixes

• Improves performance when inputing text in large documents
• Fixes the issue where the document pane title, as defined in the desk structure, was not being utilized properly
• Fixes a problem where intent route would not open the correct desk structure

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

🐛 Notable bugfixes

• Fixes a recent regression where Portable Text annotations within nested content could not be properly edited

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

🐛 Notable bugfixes

• Fixes a regression from v3.8.0 where annotations could not be edited in Safari
• Fixes an issue with duplicate keys when pasting empty lines into an empty Portable Text input

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

✨ Highlights

Improved global create menu

The global create menu has been updated with alphabetically sorted options and a search field, providing a more convenient way to find a desired document. The menu has also been redesigned to appear in a popover instead of a full screen dialog for improved UX and less context switching.

🐛 Notable bugfixes

• Fixes a recent regression in the Portable Text Editor where pasting content into an empty editor would cause an error
• Fixes content overflow bug for query results in Vision and adds scroll bars to the result pane
• Fixes issue where focus was not being returned to the editor after changing the style of a Portable Text block
• Improves performance and issues related to validation in the Portable Text Editor

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

🐛 Notable bugfixes

• Fixes an issue where an array field’s value is not set to undefined when the last item is removed
• Fixes hydration mismatch issues
• Fixes an issue where preview panes are not preserved on smaller screens
• Fixes an issue where the studio may crash when accessing history changes with reduced permissions

📓 Full changelog