Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npm create sanity@latest

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

npm install sanity@latest

Notable changes

• Increases the default height of the Portable Text editor

Notable bugfixes

• Fixes the --enforce-required-fields flag for the sanity typegen generate command not correctly respecting validation rules
• Fixes a few focus issues where the Portable Text editor would sometimes jump to the start of a block or scroll to a previously opened block on focus inside of the Presentation tool
• Fixes an issue in which when the tasks panel is open, searching for content in the Cmd + K search changes target document rather than searches 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

🐛 Notable bugfixes

• Fixes an issue where clicking "Publish" and possible other actions would throw the error Sanity LocaleContext value missing.
• Fixes an issue in which users' names were sometimes displayed in lowercase in the tasks assignee 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 bugfixes

• Fixes an issue where the studio might crash on "orphaned marks" in the Portable Text Editor.
• Fixes an issue that caused the tasks plugin to be inserted multiple times in studios using more than one instance of the Structure Tool.

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npm create sanity@latest

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

npm install sanity@latest

✨ Highlights

Sanity TypeGen (beta): Generate types for your schema and GROQ queries

This release comes with Sanity TypeGen, the new tooling in the Sanity CLI that enables extracting the schema into a static representation (schema.json) and to generate TypeScript type definition for it, as well as for GROQ query results.

You can learn more about Sanity TypeGen:

• Blog post: Of course, you should be able to type your content quickly!
  
• Documentation
• New course on Sanity Learn

If you try out Sanity TypeGen, do let us know how it went in the #typescript channel in the Sanity community or to your customer success team.

Tasks (beta): Delegate work within Sanity Studio

This update also includes the beta of Tasks for Sanity Studio. It's a way to assign tasks related to documents, delegate them to team members, and track their status across the project.

If you wish to disable tasks, you can do so by adding the following to sanity.config.ts:

export default defineConfig({
  ...restOfConfig,
  unstable_tasks: {
    enabled: false,
  },
})

Documentation for Tasks is in the works and will be announced when ready.

🐛 Notable bugfixes

• Fixes a bug where all fields got marked as non-optional when extracting schema with --enforce-required-fields.
• Fixes a bug where Vision would insert new line on cmd-return.

On styled-components@5?

If you encounter an error such as TypeError: Cannot read properties of undefined (reading 'div'), please make sure your Studio doesn't depend on styled-components@5. Updating any such dependencies to styled-components@6 should resolve the error:

npm install styled-components@latest

This error is caused by an ESM/CJS compability issue in @sanity/ui.

📓 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 caused inputs to lose focus when their value changed

📓 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

• Increases width of all inline popovers in the Portable Text Editor
• Fixes an issue where incorrect studio version was shown in the help menu
• Fixes an issue where incorrect loading message shown while a pane is resolving in the structure 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 an issue that would cause duplicate entries in the list of recent searches.
• Updates the type of value within ObjectFieldProps to accept a type parameter, allowing for dynamically setting the expected type. (thanks @shixish)

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npm create sanity@latest

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

npm install sanity@latest

✨ Highlights

Persisted user settings

User settings (like desk list sort orders, view modes, and global search history) are now stored securely server-side by Sanity. This means that these settings do not need to be re-selected across devices or browsers, and will be persisted wherever a user logs into their Studio.

🐛 Notable bugfixes

• Fixes a bug in the Portable Text Editor where merging two text blocks could result in data loss in the topmost block when several editors are inside the document.
• Migration CLI tooling now always places its output in the project root, and provides better messaging about this.

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

npm create sanity@latest

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

npm install sanity@latest

🐛 Notable bugfixes

• Resolves an issue where users were not redirected to their original destination after re-authenticating, ensuring seamless access to linked content within the Studio.
• _projectId and _strengthenOnPublish are now valid values for Initial Value Templates, allowing for Cross Dataset Reference values in templates.
• Fixes a type bug where the type for defineType and defineField was not being captured correctly.

Other Features

• __experimental_search is deprecated in favor of field-level search options for strings and Portable Text arrays. You should now be able to define search weights in your schema, like:

defineField({
  name: 'title',
  type: 'string',
  options: {
    search: {
      weight: 10,
    },
  },
})

• Document Actions can now specify a group, which will allow users to specify whether a specific document action should appear in the footer or in the document's context menu.
• Adds ability to open the hotspot and crop dialog by double-clicking image preview.

📓 Full changelog

Installation and upgrading

To initiate a new Studio without installing the CLI globally:

  npm create sanity@latest

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

  npm install sanity@latest

✨ Highlights

Inline commenting in Blocks

Enhance editorial collaboration with the ability to attach comments directly to specific text selections. This feature includes highlight capabilities and ensures a seamless experience with updates and scrolling interactions.

Comments is available on the Growth plan (30-day free trial on new projects). You can learn more about comments in the documentation.

🐛 Notable bugfixes

Fixes sluggish document list due to lingering listeners

We've implemented a cleanup mechanism for edit state listeners to resolve issues that caused the document lists to become sluggish. Prior to this fix, open connections weren't being closed properly, leading to slow performance and potential crashes. If you've been experiencing delays or stability problems in your document lists, this update addresses those concerns.

📓 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

Portable Text Editor improvements

• Inline references and objects will now render with increased default sizes in the Portable Text Editor for easier interaction.
• Original content keys are now preserved during undo/redo operations in the Portable Text Editor. This change makes for more robust content integrity.

🐛 Notable bugfixes

• Fixes an issue that allowed files to be dropped behind the open modal, leading to potentially adding files to the wrong input.
• Fixes a problem where temporary network disruptions could cause the form editor to reload and lose unsaved edits. Now, the form becomes read-only during reconnection, preserving state and changes.
• Fixes an issue where initial value templates would not accept a target dataset for cross-dataset references.
• Fixes an issue where the "disabled" state was shown indefinitely for cross-dataset references.
• Resolves a UI problem where the "cannot upload" message was incorrectly shown for extension-restricted file types during hover.
• Fixes a bug where certain selections within the Portable Text Editor were being mishandled.
• Fixes an issue where Comments would show a loading state while the form was reconnecting, preserving user comments during network issues.

📓 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

• Added reference documentation for the sanity/migrate APIs.

Other features

• Adds ARIA labels to navbar icons for better accessibility.
• Fixes an issue in which the free trial popover was shown twice for new users.

🐛 Notable bugfixes

• Updates placeholder color for Portable Text Editor.

📓 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

Improvements to Comments in Presentation

With the recent introduction of both Presentation tool and comments, we realised that context can be crucial in understanding comments relating to visual aspects of an application.

Comments created from within the Presentation tool will now display a link allowing content editors to navigate from any tool directly to the context in which that comment was made in their application.

Other features

• Improves error handling for a migration script that attempts to iterate over the passed document function without calling it
• Adds new Studio API, ActiveToolLayout, which allows plugin authors to have more flexibility by wrapping the active tool
• The selected viewport in Presentation is now persisted in the URL

🐛 Notable bugfixes

• Improves focus handling with the Presentation tool and Portable Text Inputs
• Fixes regression preventing import {debugSecrets} from '@sanity/preview-url-secret/sanity-plugin-debug-secrets' listing secrets
• Fixes a bug preventing the CLI being used inside Studio project subdirectories

📓 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

• Pins a dependency that was causing an infinite loop (Maximum call stack size exceeded)

📓 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 alert messages for published or deleted documents sometimes displayed incorrect titles
• Fixes a comments-related error dialog from inadvertently showing up to users
• Removes layout shift when loading document locations when the Presentation tool is used (#5702)
• Fixes a bug that hid unpublished documents in "Documents on this page" in the Presentation tool (#5702)
• Fixes a bug that caused the document pane to stay open in the Presentation tool (#5702)

Other features

• Adds support for importing system documents via --allow-system-documents for dataset imports
• Adds support for parameterized templates in the Presentation tool (#5694)

📓 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

Dry run content migrations from a local dataset file

You can now dry run content migration jobs against a local dataset export file (for example, a production.tar.gz file that you have exported):

sanity migration run my-content-migration --from-file=production.tar.gz

Note: The --from-file flag only works with dry runs, in other words, you won't be able to use is with the --no-dry-run flag.

Learn more about Schema Change Management in our documentation.

Other features

• Timestamps in comments display in the format of the current Sanity Studio locale.
• Improvements to migration reporting and refinements to messaging and text during migration commands.
• Unattended mode in CLI will respect plans and coupons, and defaults to plans.
• Document titles now display with balanced line breaks (text-wrap: pretty).
• Comments feature is now discoverable for all users on a non-paid plan, with UI to make plan upgrade easier.

🐛 Notable bugfixes

• Fixes an issue where the Vision tool might crash when pasting a query URL.
• Styling fixes for labels and columnar objects in the studio.
• Icon display defaults in S.documentTypeList() now match those in other document lists.

📓 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

🐛 Notable bugfixes

• Fixes a bug with sanity migrate that caused a patch to be applied twice.

📓 Full changelog

Installation and upgrading

To initiate a new Sanity Studio without installing the CLI globally:

npm create sanity@latest

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

npm install sanity@latest

✨ Highlights

New CLI command sanity migration create|list|run

You can now create, list, and run content migrations from the Sanity CLI. The new tooling lets you scaffold content migrations as code and run them in dry and production mode. It also introduces a new API for defining content migration with helper functions (defineMigration()).

We're still working out the documentation for schema and content migrations; early adopters can learn more by running the following CLI commands in a Sanity Studio project folder:

sanity migration --help

You can run sanity migration create to explore our new content migration templates.

New CLI command: sanity schema validate

You can now validate a Sanity Studio schema with the CLI command sanity schema validate. Among other things, it will identify problems with your schema type definitions. This tooling can be useful for running in CI/CD pipelines or debugging your schema configuration.

Learn more by running:

sanity schema validate ---help

Other features

• Adds Studio UI localization support to the comments plugin
• Adds support for validating dataset import and export files with sanity documents validate
• Adds intentUrl in json and ndjson formats for sanity documents validate

🐛 Notable bugfixes

• Fixes a type issue where Rule.min and Rule.max did not allow strings
• Fixes an issue where large documents would not duplicate correctly
• Fixes an issue with date validation when using custom format for dates
• Fixes typo in asset source string (thanks @kkupcin)
• Fixes an where valid documents would be reported in sanity documents validate --format json
• Fixes a bug that caused uses of Vite-like environment variables import.meta.env to break the mock browser environment used in the CLI.

📓 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 introduced in v3.26.0 where, upon the first comment in a project lacking an addon dataset, the dataset fails to be created, and the comment remains unposted.
• Enhanced export reliability through improved asset retry mechanisms.

📓 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

Deprecation support for Documents and Fields

This release introduces the option to mark document and field types as deprecated. This can be used to gently steer Studio users towards updated schemas or to phase out legacy fields without abrupt changes.

export const deprecatedDocument = defineType({
  name: 'deprecatedDocument',
  title: 'Deprecated Document',
  type: 'document',
  deprecated: {
    reason: 'Use the Author document type instead',
  },
  fields: [
    defineField({
      name: 'title',
      type: 'string',
      deprecated: {
        reason: 'This field was used in a legacy system and is no longer used.',
      },
    }),
  ],
})

When a field or document is deprecated, an informative message will appear in the Studio, clearly indicating the recommended action to take. This aids in maintaining a clean and up-to-date content structure.

Bonus: Deprecation messages now appear in the GraphQL schema, providing clarity during transitions. Deprecated document types and fields should be appropriately treated in documentation and tooling.

Reactions to Comments

This release also introduces a new layer of interactivity in the Studio with the ability for users to react to comments! 🎉

Far be it from us to speak ill of verbose and precise communication using full sentences, but sometimes you just want to express a sentiment quickly with a 🚀 or a 👍 and Sanity Studio now has you covered for those occasions. Streamline feedback processes and consensus building, and make your Studio a more vibrant collaborative space in one fell swoop with comment reactions. 🎩

🐛 Notable bugfixes

• Enhances user experience in the Studio by adding localized browser document titles and correcting unlocalized strings, accommodating users who prefer languages other than English.
• Fixes an issue where number-like string flags passed to CLI commands were parsed as numbers by the option parser, leading to truncation of large integer-only document IDs and similar.
• Resolves a restoration issue with the token login method ensuring the active session is retained post webpage reloads when cookieless auth is in effect.
• Enhances UI components consistency in tooltips and delay groups for better UX.
• Fixes a performance issue by re-applying useMemo on DocumentPaneContext values, reducing unnecessary re-renders and improving document pane performances.
• Ensures that errors in the useFeatureEnabled hook result in an empty features list rather than disruptive error toasts; this minimizes user interruption when feature availability checks fail.
• Fixes multiple bugs in the sanity documents validate CLI command relating to visibility, unnecessary validation reports, reference checks batch processing, and unknown field validation for images and file types.
• Improves spacing between the published date and the last updated date in the document status bar for better readability.

📓 Full changelog