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 Documents Validate CLI Command (beta)

https://github.com/sanity-io/sanity/assets/10551026/36dd1d32-84a3-4755-b629-1798bd845e46

The sanity documents validate command is now available! This powerful tool checks your documents against your project's schema directly from your command line. It uses a mocked browser environment to validate all documents locally, perfect for ensuring data integrity.

Note: As this feature is currently in beta, some projects may not load correctly. We encourage users to report any issues encountered to help us improve here: https://github.com/sanity-io/sanity/issues/5510

Improved Copy-Paste experience from Google Docs and Notion

The Studio now preserves formatting more reliably when content is pasted from Google Docs in Safari, and no longer incorrectly applies underline decorators to pasted links. Additionally, the Studio now preserves formatting more reliably when content is copied from a single block in Notion.

User interface and experience updates

• Root page link: The workspace icon now consistently serves as a direct link to the 'root' page (the first configured tool), streamlining navigation.
• Improved Workspace Switcher: A new tooltip feature has been added to the workspace switcher for better clarity.
• Simplified Tool Menu: The tool menu will now be hidden when only one tool is installed, reducing clutter.
• Layout stability: We've resolved an issue with long workspace titles disrupting the navbar layout. Titles now truncate with ellipses to maintain a clean appearance.
• Localized tooltip text: The 'open menu' button tooltip text has been localized and is now more accessible on smaller screens.
• Intuitive icons: The help and resources button now features the correct icon, making it more intuitive and consistent with previous versions.
• PTE improvements: Ensures that clicking to edit in presentation mode correctly focuses the relevant block, improving the editing workflow.

🐛 Notable bugfixes

• Fixes a bug where logging out didn't invalidate the cookieless auth token.
• Fixes an issue in the Portable Text Editor where the 'Empty' placeholder placement was off.
• Fixes an issue where array item focus rings were cropped, ensuring they're now displayed in full.
• Fixes a bug where the workspace switcher tooltip wasn't displaying correctly.

📓 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

Updated legacy theme customization

Legacy themes for Sanity Studio will now handle custom colors without losing the scaffolding provided by the default studio theme. This improvement means that the custom colors you define will no longer revert to default values, but instead integrate seamlessly with Sanity Studio.

Experimental document pane title opt-out

A new flag __experimental_formPreviewTitle has been introduced, allowing you to hide the large preview title displayed in the document pane form. This grants more control to users with custom implementations that do not benefit from this title being displayed.

import {defineType} from 'sanity'

export const playlistType = defineType({
  name: 'playlist',
  type: 'document',
  // 👇👇👇
  __experimental_formPreviewTitle: false,
  // 👆👆👆
  // ...
})

Comments feature now enabled by default

The comments feature within Sanity Studio is now enabled by default, embracing collaboration and social interactions on your documents right out of the box.

Importing Structure as structureTool

The import path for the structure tool has been updated. Developers should now import from sanity/structure instead of sanity/desk. A helpful codemod is available to facilitate the migration of any existing code. Existing imports to sanity/desk will still work but those imports have been marked as deprecated and will be removed in a later major version.

A codemod is available to migrate any code that may be using it:

npx @sanity/cli codemod deskRename

Be sure to check in any local changes to version control before running the codemod in case it should fail.

GraphQL deployment optimization

A new opt-in cache, --with-union-cache, improves GraphQL schema generation speed by up to 95% for schemas with numerous self-referencing documents. This optimization is essential for larger projects and significantly improves the deploy experience.

🐛 Notable bugfixes

• Fixes a regression where custom document action modal dialogs were not rendering footer content correctly.
• Resolves issues related to incorrect default locale strings, ensuring the restoration process of document revisions is accompanied by proper messaging.
• Fixes problems with the strike-through formatting when pasting content from Google Docs.
• Corrects font weight rendering issues on iOS16, ensuring consistent visual experience across platforms.
• Fixes the improper alignment of button text in the Portable Text Editor to match standard UI practices.
• Ensures annotation toolbar popover in PTE follows the correct element on scroll, enhancing usability.
• Fixes fieldset border issues in forms for a cleaner UI presentation.
• Resolves console warnings stemming from passing non-DOM properties to styled-components.
• Updates navbar button positions for better user discoverability and accessibility by adding aria labels to expand buttons in PTE.

📓 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 occational wrong placement of the free trial popover
• Fixes an issue where custom icons were displayed with incorrect sizes in previews

📓 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

• Makes sure latest version of next-sanity is installed when initializing in a Next.js project

📓 Full changelog

🐛 Notable bugfixes

• Improves error handling if enabling telemetry consent fails
• Fixes an issue that could happen if using an older system version of the Sanity CLI in combination with a more recent version installed in a project directory

📓 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 missing subtitle in object and reference previews inside arrays
• Improves error handling if enabling telemetry consent fails
• Fixes issue with inverted color for field action buttons
• Fixes an issue that could happen if using an older system version of the Sanity CLI in combination with a more recent version installed in a project directory

📓 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 relative time formatting in certain languages

📓 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 relative time formatting in certain languages
• Fixes some peer dependency warnings

📓 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

Early release: Sanity Studio UI Upgrade

We have been working on updating and finessing the Sanity Studio UI for a while. We think it is quite an improvement and will talk more about it as we return after New Year's.

We wanted to get it out before the holidays to learn how it works for new users and allow existing users to test it out with any Studio customizations they might have. We might have missed edge cases, so if you encounter anything — do let us know

We will also publish new versions of Sanity UI with corrensponding documentation — stay tuned!

To upgrade: npm install sanity@latest

To downgrade to the last stable release: Pin the sanity dependency in package.json to 3.22.x and run npm install

📓 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

📓 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

🌍 Publish! Veröffentlichen! Publicar! 公開!: Sanity Studio UI Localization! 🌍

The Translate the studio UI #1603 issue has been one of our most popular feature requests on GitHub. Now we can finaly close it, because we have launched Studio UI localization.

What's New?

• Multilingual support: You can now configure the Sanity Studio user interface to use languages other than English. We're kicking off with many languages, including Spanish, French, Norwegian, German, Portuguese, Korean, Turkish, Icelandic, Thai, Vietnamese, Swedish, Finnish, Czech, Italian, Japanese, Chinese, and Polish. Don’t see your preferred language? It's easy to request additional language plugins!
• AI-Translated language plugins: These initial translations are generated by AI — we're inviting the community (that’s you!) to help us improve and maintain these translations for accuracy and cultural relevance. Interested? Read more about how to contribute over on GitHub.

First steps to a localized Studio

This is our first step towards a fully global studio. The support for localization will grow, starting with our official plugins. We appreciate your patience and contributions as we expand these capabilities!

Getting started:

• Choose your language: Visit github.com/sanity-io/locales to find the plugin for your desired language. If it's not listed, we’d love you to request it - we can do a first auto-translated pass, and you can help us review and improve the automated translations.
• Plugin setup:
  • Ensure you are using Sanity version 3.22.0 or newer
  • Install the plugin for your desired language (npm install @sanity/locale-nb-no)
  • Import it (import {nbNOLocale} from @sanity/locale-nb-no
  • Add it to your studio's plugins array (plugins: [nbNOLocale()])
  • You’ll find full instructions on the locale plugin’s README!
• Documentation:
  • How to localize the Studio UI
  • How to internationalize a plugin

We're eager to hear from you and welcome any feedback. This is just the beginning, and your insights are invaluable in making Sanity Studio even better.

Introducing telemetry 📡

As a product company, we have to prioritize what to work on. Ideally, those decisions are based on a healthy amount of vision (how we think things could be better) and insight (how people use the product). We have had a good amount of the former but less of the latter.

With this release, we’re introducing telemetry data collection in the CLI and Studio. Participation is optional, and you can easily opt-out by running npx sanity telemetry disable, setting the DO_NOT_TRACK=1 environment variable, or visiting Account Settings in Manage. For more details on what data is collected, how it’s being used, and how consent is handled, go to sanity.io/telemetry.

Other features

• Adds experimental support for using Bun as package manager when creating new Sanity projects (bun create sanity)
• Adds ability to customize the suffix added to auto-generated GraphQL filter types (Filter by default), by configuring filterSuffix in the GraphQL configuration of sanity.cli.ts

🐛 Notable bugfixes

• Fixes issue where annotation popover would open in the wrong location when selecting annotation text in the Portable Text editor
• Fixes removal of marks in the Portable Text editor not always cleaning up unused mark definitions
• Fixes issue where Portable Text editor would crash when attempting to use annotations on text over multiple blocks
• Fixes issue in which new empty text blocks were added when adding a non-text block in the Portable Text editor.
• Fixes an issue where selecting a custom API version in the Vision tool would sometimes crash

📓 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 missing export for a newly introduced typescript type

📓 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 virtualization issue which caused array items to erroneously be hidden when navigating between groups inside a modal
• Fixes Portable Text Editor in expanded mode not closing when switching tabs/views
• Fixes date/datetime inputs and date search filters showing incorrect week day in calendar

📓 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 studio would crash when embedded inside a vite app

📓 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

• Removes a console warning about using an experimental API version
• Adds type declarations for the assetRequired rule to validation for image and file schema types
• Fixes an issue in the Next.js template where the urlForImage function would return a class instead of a url
• Fixes an issue where the image crop tool would not work on touchscreen devices with connected pointer devices
• Fixes a bug in the Portable Text Editors drag-and-drop functionality that would make any block which opens in a modal, that was dragged and placed directly above an array block wrongly affect the array, leading to a “Can’t upload this file here” error
• Fixes an issue where the --skip-cross-dataset-references flag was not working with sanity dataset import

📓 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

• Improves the Portable Text Editors backspace handling on text blocks that follows a non-text block
• Fixes an issue where the Portable Text Editor would crash if a block with its children property set to undefined was inserted
• Ensures that StudioLayout utilizes the components API when used in isolation
• Fixes some performance issues related to entering text into all compatible Studio inputs. Typing in Studio inputs should now be noticably faster, in particular for schema types with a lot of deeply nested fields.
• Adds node.module to package.json which improves compatibility with Webpack, Astro, Svelte and Vue

📓 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 support for non-Latin1 characters in URLs

Sanity Studio now handles characters outside of the Latin1 range in intent or structure tool pane payloads without crashing. This fix ensures better support for multilingual content and enhances worldwide usability.

Comments feature improvements

Continued improvements for the comments feature include a resolution to the layering issue that caused popovers to render behind the document pane.

The comments feature also received a quality-of-life enhancement by ensuring that the comment discard dialog appears above the document pane footer and headers, making it fully visible and accessible.

Lastly, we fixed a focus behavior where the reply comment input would unintentionally gain focus when clicking outside of it. Sanity Studio now maintains focus appropriately, only triggering when the comment input field is deliberately selected.

🐛 Notable bugfixes

• Fixes the PTE toolbar menu behavior, ensuring only one menu can be open at a time.
• Resolves the odd focusing issue around comment reply inputs.
• Corrects the visual layering of the comment discard dialog to avoid it being hidden by other elements.

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npm create sanity@latest

To upgrade Sanity Studio, run this command in your project folder:

npm install sanity@latest

✨ Highlights

Introducing Presentation

Separating content from presentation shouldn’t create friction. With Presentation, you can work visually – with a clear view of structured content reuse. Presentation and visual editing is available on all plans.

Learn more about Presentation in the launch blog post

Introducing Comments (beta)

Streamline your content review process. From in-document communication to organized feedback, Comments enhances teamwork across all stages of content creation. The new Comments feature is available for projects on the new Growth plan, and up.

Learn more about the Comments beta launch

Desk is now Structure

With the launch of the new Presentation tool, we have renamed the Desk tool to Structure. There are no changes in APIs at this time and no required code changes. In the near future we will rename the export and add a deprecation warning to the existing deskTool.

For those that are depending on the old tool name desk in Studio customizations, this identifier changes to structure in this release and you should update your code accordingly.

Learn more about this change.

📓 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

• Makes field actions keyboard-accessible:

  • Enables pressing the Esc (Escape) key to discard a comment.
  • Fixes an issue where hovering over field actions (for example: Comments, AI Assist) when they're not visible would cause them to flicker.

• When importing and exporting datasets with the import dataset and export dataset CLI commands, the output message includes information about the projectId and the dataset in question.

  Example:

  

  

• Fixed an issue with cursor instability when using the Portable Text Input inside another Portable Text Input's embedded objects.

📓 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

This release includes minor UI fixes and improvements

📓 Full changelog