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 changes

• Adds v2022-03-08 to list of predefined API versions in the Vision plugin
• Hotkeys are now displayed using platform-aware keys (eg Opt instead of Alt on Mac)

Notable bugfixes

• Fixes an issue where references would not open in-place, instead yielding an error about being changed after opening

📓 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

This release adds support for styled-components v6. This is an optional upgrade as we'll continue to support v5 during the lifecycle of Sanity Studio v3.

🐛 Notable bugfixes

• Fixes a bug where pasting HTML lists into the Portable Text Input would disregard schema configuration for list blocks.
• Fixes an issue where logos of custom auth providers were missing on login screen.
• Fixes an issue where pasting from Google Docs to the Portable Text editor would apply bold formatting to the pasted content on Windows computers.
• Fixes minor issue causing the annotation toolbar popover to not always display correctly.
• Fixes a bug where the Portable Text input would capture focus trying to edit an inline object's field named .text.
• Fixes an issue where certain patches would apply differently in the studio and in Content Lake, leading to the studio UI not reflecting the new values for some fields.
• Fixes an issue where certain remote patches would not cleanly apply in the studio, requiring a reload of the document to see the changes.
• Fixes an issue where using >= or <= JSONMatch filters for patch operations would cause the studio to return error messages and not apply the patch correctly.
• Fixes published and edits message in the document list.

📓 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 changes

• Fixes a typo in a validation error message (thanks @largis21!)
• Fixes an issue where schema error messages would be shown with overlapping text on long titles/field names
• Improves typescript documentation for portable text/block content related types
• Adds some metadata to cross-dataset references when deploying GraphQL APIs in order to allow programatically resolving reference

📓 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

• Responsive improvements to the Vision plugin to accommodate narrower screens
• Updated icon for copy buttons
• Bump engines.node to >= 18

🐛 Notable bugfixes

• Fixes type for canHandleIntent to allow passing undefined
• Fixes placement of "Add item…" popover in array inputs
• Fixes a bug where edit intent was not called when added to a menuItem (thanks @israelroldan 🙏)

📓 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

Perspectives in listenQuery

Added support for perspectives in the listenQuery() method

🐛 Notable bugfixes

• Fixes an issue where reverting all changes to an array of primitives would not clear the list as expected
• Fixes syntax errors in schema files when initializing a blog template without Typescript in a Next.js app
• Fixes an issues with array items not showing all items inside a field group under specific conditions
• Fixes rendering issues with certain popovers being caused by wrong placement
• Improves accessibility for document lists
• Fixes an issue that could sometimes make reference validation errors disappear when switching between documents

📓 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

Improved validation of Block Schema Members

We enhanced the validation of block schema members. Block schema members cannot be given a type that is not an object-like type. In previous releases, we weren't preventing that. This could lead to unexpected errors. In this release we addressed the issue by giving certain permissions and warnings for particular scenarios. More details can be found in the PR description.

Title updates in Desk Tool

In this release, we improved the navigation inside the studio by updating the <title> element to make it more specific to the current route every time a user navigates in the studio. This makes it easier to navigate through documents and switch between tools.

Increased performance for dataset imports

Past versions encountered challenges with concurrent operations during parallel reference strengthening; this issue has been resolved for some time. The current release enhances import performance by further optimizing parallel strengthening of references. This greatly improves import performance.

Other features

Simplified managing reference publishing icons by adding aria-labels for accessibility.

🐛 Notable bugfixes

• Fixed a visibility issue related to breadcrumbing in the review changes section. Made the breadcrumbs consistent with the new breadcrumb styling.
• Fixed an issue where dialogs wouldn't properly appear at smaller breakpoints.
• Minor fix with the restore document history function in the desk tool related to nested panes.
• Use the index as a key instead of the path in the desk tool to handle multiple validation errors for the same field/node.

📓 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 the Portable Text Input toolbar where it didn't reflect the active decorators state in some situations.
• Fixes slug input field appearing as nested object

📓 Full changelog

Invalid release

This version was erroneously published - please use v3.16.4.

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 v3.16.0 that prevented reference validation errors from appearing in certain cases

📓 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 that could make certain queries fail due to switching back to an earlier API version

📓 Full changelog

Installation and upgrading

Fresh install

To install and initiate a new Sanity Studio without installing the Sanity CLI globally, run the folling command in the terminal:

npm create sanity@latest

Upgrade

To upgrade an existing instance to Sanity Studio v3, run the following folling commands in the terminal:

# Go to the root folder of the installed Studio instance
cd path-to/sanity-studio/root-folder

# Upgrade Studio to v3
npm install sanity@latest

✨ Highlights

In a nutshell:

• Enhanced Portable Text editing experience.
• Faster syncing.
• Full support for Portable Text on Android devices.
• Offline detection

Improved Unicode support

Sanity Studio uses the diff-match-patch algorithm to match and patch document changes. In previous versions of the Sanity Studio, the underlying library wouldn't work correctly when parsing some Unicode characters. We addressed those issues in this release.
If you experienced issues when using characters such as emojis, Kanji, or other non-Latin characters, this release fixes these issues.

Enhanced Portable Text editing

Besides improved Unicode support, the Portable Text Input and the underlying text editor feature a number of improvements to provide a smoother editing experience.

Faster synchronization

Previously, prolonged fast typing in the editor would trigger debouncing: the Portable Text Input would temporarily suspend committing edits, until you decreased your typing speed below a specified threshold.
This behavior could produce bigger discrepancies between your local value and the corresponding actual value stored in the server side.
Now your changes are committed in a throttled way: the editor commits the changes as you type, without compromising performance.

Improved undo and redo

Undo and redo features have been improved considerably, especially when working with several editors on the same document.

Better Android support

The Portable Text Input is now fully supported on Android. Previously, typing in the editor using an Android on-screen keyboard would cause some issues.

Offline detection

The Portable Text Editor automatically enters read-only mode if it detects that the network is offline.
This behavior helps keep your local document in sync with the corresponding copy on the server when there is no online access, and it prevents losing changes as a consequence of not committing them.

Other features

• The sanity module is now marked as free of side effects, which can produce smaller bundle sizes (thanks @mckelveygreg! 🙏)
• Improved UX when deleting a document.

🐛 Notable bugfixes

• Fixed a bug where changing text styles in the Portable Text Editor would cause the editor to lose focus.
• Fixed a problem that would occur when repeatedly applying and removing text decorators while typing in the Portable Text Input.
• Fixed the odd placement of the "Empty" placeholder in the Portable Text Editor on WebKit browsers.
• Fixed a media visibility issue in Safari occurring in list previews with custom SVG elements.
• Fixed the alignment of action items in pane headers on mobile devices.
• Fixed a padding inconsistency in reference fields.
• Fixed a visibility issue affecting tooltips in the navigation bar, and causing them to be displayed behind open menus.
• Fixed an issue affecting cross-dataset reference fields displayed as nested fields, inconsistent with regular reference fields.
• Fixed a bug that caused specifying apiVersion on documentList() and documentTypeList() to not work in the desk structure.
• Fixed the initial flashes of validation errors for valid content on document load.

📓 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 package managers were pulling wrong version of the get-it package which is a sub-dependency of the @sanity/client package
• Fixes an issue that would sometimes cause document lists to not refresh properly after adding or removing a document
• Fixes issues where timeouts were being cancelled (thanks @balexand!)
• Fixes an issue where certain GROQ-filters used for access control rules would crash the studio

📓 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

• Adds new token login method for rare cases when the more secure cookie approach is not viable/wanted
• Enables specifying authentication options using an object instead of createAuthStore()
• Adds new is_defined filter to GraphQL APIs, mirroring the defined() function in GROQ. GraphQL APIs will have to be re-deployed to enable the new filter.

🐛 Notable bugfixes

• Improves performance when fetching projects list as part of the sanity init CLI command
• Fixes an issue that would give intermittent validation errors for valid string values when using a regex with global flag
• Fixes an issue where references to undeclared document types would never load
• Improves error UIs for reference values
• Improves the changes pane to show path line and change indicator correctly for the following field types:
  • Array of strings (array of type string)
  • Array of tags (array of type string with layout: 'tags')
  • Array of strings (array of type string with options.list)
  • Array of emails (array of type email)

📓 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

• Various microcopy improvements
• Adds isSlug() method to @sanity/types for type-safe asserting of a slug object
• Fixes an issue where using multiple desk tools in the same studio would cause duplicate "review changes" actions and validation lists to appear. Thanks @andparsons!
• userHasRole will now accept null as well as a user object, making it more convenient in certain situations where the user might not yet be accessible
• Fixes issue with auto scrolling on collapsed fieldset
• Fixes issue where array list would not display all items when wrapped in a custom element
• Fixes issue where array list would not display when inside a popover

📓 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

• Implements the 'document' creation context in the document.newDocumentOptions API
• Fixes an issue where exported datasets with cross-dataset references could not be imported to different projects. Note that referenced datasets must exist within same project - otherwise use --skip-cross-dataset-references.
• Removes warning about missing titles for schema types (titles are automatically created based on schema type name - a title is only necessary if the automatic name is incorrect/inaccurate)
• Titles are now automatically applied to field groups and fieldsets, in the same way as with schema types.
• Improves error messages from configuration errors
• Boolean inputs will now show validation errors at the input level
• Fixes alignment/scrolling issues of references in delete/unpublish dialog
• Fixes accessibility issues in tooltip text color contrast
• Fixes various accessibility label issues in the desk tool
• Fixes issue where focus would jump to first element when hovering divider in menu
• Fixes an issue where the fallback editor had the title "Editor", instead of the name of the document being edited

📓 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 the v2 version of the Command Line Interface (CLI) with:

npm install --global @sanity/cli@v2

Upgrade Sanity Studio with:

sanity upgrade

🐛 Notable bugfixes

• Minor fixes and improvements to studio search

📓 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 changes

• Added scrolling to list of workspace (when many workspaces are configured)
• Improved contrast of text in certain tooltips

📓 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 the styled-components dependency would not be installed when installing Sanity in an existing project
• Fixes an issue where the "Restore" document action would sometimes not restore the document
• Fixed an issue where the fallback editor had the title "Editor", instead of the name of the document being edited

📓 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 issue with small hit area for collapsible fieldsets.
• Fixes an issue where using sanity init on a Next.js project with embedded Studio would result in an error if an outdated version of next-sanity was being used.

📓 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

Support for Perspectives in Vision

Coinciding with today's studio release, we're bringing support for trying out Perspectives in the vision plugin.

With Perspectives, you can add a single parameter to fetch a either the latest draft (previewDrafts) or latest published (published) version of a document.

To learn more about Perspectives, read our announcement post or our documentation.

New Help & Resources menu

We've consolidated some helpful resources to customize the Studio experience, learn more about our latest updates, and connect with our team. You can also compare your current Studio version to the latest version available.

📓 Full changelog