🐛 Notable bugfixes

• Fixes an issue where CLI templates would import from the wrong module in dev-preview.16

📓 Full changelog

✨ Highlights

Less custom input boilerplate

This release introduces a new spreadable elementProps property to all input components.

This currently includes things like onFocus/onBlur event handlers, ref, value (for primitive inputs) and an onChange that handles "native" React change events and emits the correct patches.

The intention is that you can safely pass (or "spread") these on to any "native" input element. This reduces the amount of boilerplate needed for custom inputs - especially those dealing with primitive values, and handles things like unsetting the field if the value is empty, extracting the value from a change event and similar.

For inputs dealing with complex values (objects and arrays), value is not included in elementProps, since it doesn't make sense to pass it to any native input.

This change also includes moving the change indicator rendering from individual primitive input components to their corresponding field component instead. This means even less boilerplate is needed in order to render a simple input component. In the future, we will provide a way to opt-out of this behavior, should you wish to handle the rendering of the change indicator yourself.

These changes means that in essence, all you need for the most basic custom string input would be:

import React from 'react'
import {StringInputProps} from 'sanity'

function StringInput(props: StringInputProps) {
  return <input type="text" {...props.elementProps} />
}

Note that this change means that input components will receive two "values" - props.value will now be of the "parsed" type defined in the schema (e.g. number), while elementProps.value will always be a string, since its intended to being forwarded as an attribute to the native HTML input element.

Context improvements

Custom validation functions and initial value resolvers now gets an extended context parameter passed to them, which includes the schema, the current user and a getClient() function.

Other features

• Now prints a warning when attempting to use an array with layout: 'tags' and a preconfigured list of options
• Now supports URL imports in sanity.config.ts
• Custom diff components are now supported and can be specified on schema types using the components.diff property
• A logo can now be passed to the configuration and will be rendered in the navigation bar. Note that this property name might change in an upcoming release, but we are including it for people who want to start working on the rendering of their studio logos.
• Studio loading should be between 50-300ms faster

BREAKING CHANGES

This release includes a few breaking changes:

Versioned client

The useClient() hook now requires you to pass an API version, for instance: useClient({apiVersion: '2022-09-14'}). This allows us to upgrade the API version used throughout the studio without breaking any custom queries or other requests performed from user code.

Similarily, the client property in various contexts (validation, config, initial value resolvers) is deprecated - instead there is a getClient() method attached to the context which takes the same API version configuration.

Router imports

Router imports have been moved from sanity/_unstable to sanity.

🐛 Notable bugfixes

• Fixes an issue where the reference input would sometimes be stuck in an initial loading phase
• Fixes an issue causing the tags layout not to work for string array inputs
• Fixes an issue where the content inside of a portable text annotation popover would sometimes not be displayed
• Fixes placement of custom markers in the portable text editor
• Fixes an issue where closing an empty array item would not automatically remove the item
• Fixes an issue where aliased schema types would get an extra layer of indentation in forms
• Fixes a peer dependency issue in @sanity/vision potentially causing installs to fail
• Fixes icons not being shown in certain structure panes
• Fixes an issue where previews using values from a schema type with a preconfigured list of options would use the name instead of the title
• Fixes an issue where fieldsets would not respect the readOnly property
• Fixes an issue where after hot-module reloading had been applied, some schema properties would not be reflected on Webpack-based environments such as Next.js
• Fixes an issue where the error screens would not be reset after a hot-module reload
• Fixes a bug where an invalid/expired session might cause the authentication screen to continously fail

📓 Full changelog

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

🐛 Notable bugfixes

• Fixes styling of a columnar fieldsets
• Fixes an issue where older versions of Safari might crash when opening a referenced document
• Fixes an issue with the cursor disappearing when arrowing down to the bottom of a collapsed Portable Text Input field
• Fixes a Safari issue where the Portable Text editor's selection is reset when returning from an object edit modal of an embedded Portable Text object
• Improved read only mode for the Portable Text Input

📓 Full changelog

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

✨ Highlights

Performance improvements

This release brings a number of performance improvements, mostly related to excessive re-rendering of components that do not change. Notable improvements are:

• Better performance for presence indicators when many users are logged in at the same time
• The Portable Text Editor should be faster and re-render less often

🐛 Notable bugfixes

• Mitigated an issue that could cause a draft document to be overwritten by an earlier version after publish
• The Presence list in the toolbar will now only show users who are working in the same dataset

📓 Full changelog

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

✨ Highlights

Accessibility improvements

• Screen readers will now identify that the main language in the Studio is English
• Various accessibility improvements

📓 Full changelog

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

🐛 Notable bugfixes

• Fixed an issue where incorrect references to image and file assets would crash the studio and display invalid diffs

📓 Full changelog

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

✨ Highlights

Improved search 🕵️

• Adds support for filtering search results by any number of document types. You can also browse documents from any number of types without entering a search query.
• Search is now toggleable with a hotkey (Command/Control-K) and fully navigable by keyboard.
• Recent searches (including selected document types) are stored for later use
• Search terms and results are retained upon close: handy if you want to quickly revisit or amend your last search
• Improves performance when rendering and scrolling through large result sets
• The search dialog is wider, giving you more space for the search result listing

NOTE: Documents listed in search results will no longer resolve custom components for block content and array views

🐛 Notable bugfixes

• Fixes a case where sanity init would fail if ran inside of a yarn workspaces/monorepo setup in certain cases
• Fixes a case where sanity init would fail if ran inside of a yarn workspaces/monorepo setup in certain cases
• Fixes an issue with initialValueTemplates() being overridden if you called other methods after it
• Fixes an issue potentially causing npm to go into an infinite loop when installing @sanity/core

📓 Full changelog

🐛 Notable bugfixes

• Fixes a bug causing built studios to get a React hooks/minification error
• Fixes a few performance and stability issues in the Portable Text editor
• Fixes a bug where string array fields would not allow list option to have plain strings
• Fixes a few UI bugs with the array of tags input

📓 Full changelog

🐛 Notable bugfixes

• Fixes a bug where the sanity dataset export command might fail to export assets because of an authorization error
• Fixes a bug where the sanity dataset export command might fail due to a hash mismatch
• Fixes a bug where the sanity build/sanity deploy commands might fail because of a virtual entry module used in the vite config
• Fixes an issue where the Sanity CLI would fail to use the correct Sanity version if both Sanity v2 and Sanity v3 was found in the same directory tree

📓 Full changelog

✨ Highlights

Vision v3: Query GROQ from the Studio

The @sanity/vision plugin now supports Sanity Studio version 3! Use the dev-preview tag when installing it:

npm install @sanity/vision@dev-preview

To enable it, import the vision plugin and add it to the plugins array in your sanity.config.ts/sanity.config.js file:

import {visionTool} from '@sanity/vision'

export default createConfig([
  {
    // ... other configuration ...
    plugins: [
      deskTool(),
      visionTool({
        defaultApiVersion: '2022-08-15' // optional
        defaultDataset: 'production'    // optional
      }),
      // ... other plugins ...
    ],
  },
])

Learn how to only load the plugin in development mode (that is, not enabling it when deployed to production) in Vision's documentation.

Vision v3 also supports dark mode and Studio themes, as well as letting you cancel in-progress queries.

Other features

• The development server and build tooling now use Vite 3
• If the Studio does not have the correct CORS origin setup, an error dialog will now be displayed to indicate this
• Improve configuration validation of workspaces
• Allow omitting the name and basePath properties if only a single workspace is defined
• Improved appearance of the Studio error boundary
• Improved performance of the Portable Text Editor
• Implemented fallback message for browsers where JavaScript is disabled
• sanity build/sanity deploy up to 5x faster
• Presence is now supported for users using cookieless authentication
• When a user does not have access to the Studio but is authenticated, the login provider used is now displayed

🐛 Notable bugfixes

• Fixes an issue where readOnly would not be respected in certain cases
• Removes a few peer dependency warnings
• Fixes an issue where installing dependencies using yarn when creating new projects might fail if yarn 3 was used
• Fixes display of arrays with layout: 'grid'
• Fixes the development server not allowing the use of _document.js with JSX
• Fixes incorrectly typed props for user pane view components
• Improves the accessibility of image actions menu
• Fixes an issue where opening the image actions menu on image inputs inside of portals would not work
• Fixes an issue where certain edit dialogs would say Edit undefined instead of Edit file (or similar)
• Fixes a potential crash if the file and image fields had incorrect values. Now provides an option to reset the value
• Fixes an issue where a large amount of references in a document might crash when attempting to validate the document
• Fixes an issue where cookieless auth users might see an error about being unable to align history
• Fixes an issue where the upgrade dialog would not use the correct dark/light mode
• Fixes an issue where inline types for arrays could be given the same name as globally defined types
• Fixes an issue where icons for field groups would not be displayed

📓 Full changelog

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

📓 Full changelog

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

🐛 Notable bugfixes

• Improved the UX of the new reference indicator in document pane.

📓 Full changelog

Upgrade Sanity Studio with:

sanity upgrade

🐛 Notable bugfixes

• Fixes a bug where desk tool document lists would sometimes fail to resolve a schema type for new documents when pane supports multiple types
• Reduces amount of requests triggered by new reference indication
• Fixes 404-errors being printed in developer console when checking references for unpublished documents

📓 Full changelog

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

✨ Notable changes

• A document that has references to it will now clearly indicate this with a differently colored header/footer, as well as with a link symbol. Additionally, prior to publishing a referenced document, a confirmation dialog will indicate that the change might affect referencing documents
• Added support for the presence feature when not using cookies for authentication
• Dependencies upgraded for the Portable Text Editor, fixing issues where Chrome would be reported as missing beforeInput- support after Chrome went above version 100. This broke spellchecking in Chrome and degraded performance
• Updated UI of dashboard feeds

🐛 Notable bugfixes

• Fixes rare occurring bug in the Portable Text Editor where it would stop producing patches due to non-updated instance props
• Fixes issue where the newest get-started templates did not include a gitignore file
• Fixes a potential error when trying to access a file that does not exist
• Fixes issue where field validation tooltips would sometimes be cut off when inside of modals
• Fixes an issue where exporting certain old assets would fail because of an md5 mismatch
• Fixes an issue where the unpublish dialog would use the term "delete" instead of "unpublish" in the confirm dialog
• Fixes a few warnings from being printed when navigating the dashboard
• Fixes an issue where documents with a large amount of references would sometimes fail to be published because of a failing request
• Fixes an issue where a stray margins property would be passed to a div-element (thanks @KittyGiraudel!)
• Fixes a few typos in the pets project template (thanks @nick-krantz!)

📓 Full changelog

Changes

• New studios gets bootstrapped with deploy and deploy-graphql scripts (mapping to sanity deploy/sanity graphql deploy)
• The default document node resolver for desk structures now gets the ConfigContext passed as the second argument, matching the regular structure
• Added and exposed new assertion methods:
  • isDocumentSchemaType
  • isArrayOfObjectsSchemaType
  • isArrayOfPrimitivesSchemaType
  • isObjectInputProps
  • isStringInputProps
  • isNumberInputProps
  • isBooleanInputProps
  • isArrayOfObjectsInputProps
  • isArrayOfPrimitivesInputProps
• BREAKING CHANGE: The history store no longer exposes the historyEventsFor() method
• BREAKING CHANGE: The @sanity/transaction-collator module is now deprecated and will no longer be maintained
• BREAKING CHANGE: Document nodes in structure now requires you to define a schemaType

🐛 Notable bugfixes

• Fixes issue where studio requests would not be tagged correctly
• Fixes issue where schema type errors would be caught by the global error handler instead of the specific schema error boundary
• Fixes issue where deployed studios would crash when attempting to upload images/files
• Fixes issue where studio might crash when attempting to preview a file as if it was an image
• Fixes issue where building/deploying a studio would not work if the configuration file had .tsx/.jsx extension
• Fixes issue where the global error handler would be used for known errors
• Fixes issue where the wrong order would be used when resolving input components, leading to slug input without a generate button, array inputs without drag handles and a few other cases
• Fixes a few warnings being printed to the console when publishing
• Fixes a few issues with the typescript definitions for schema declarations

📓 Full changelog

Notable bugfixes

• Fixes a few dependency installation issues caused by missing peer dependencies
• Initializes git repository on new projects after installing dependencies

Full changelog

Features

• Added new --api flag when deploying GraphQL APIs, allowing you to only deploy specific APIs instead of all of them
• The development server no longer needs to be restarted when changing a custom document component

Notable bugfixes

• Fixes a bug where the studio would be rendered in read-only mode if user did not have any roles in the current project, as opposed to showing the "Not authorized" screen
• Changes how the portable text editor handles editing of inline objects, annotations and custom block objects - using popovers for inline objects and annotations, and using dialogs for custom block objects.
• Fixes a bug where the cursor in the portable text editor might get stuck in certain cases
• Fixes a bug where an object/array input might render even if all its children were hidden
• Fixes a bug where pnpm would not be able to execute the Sanity CLI binary

Full changelog

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

✨ Highlights

Add command to list information about dataset jobs

This new command will help users find out the status of jobs without needing the job id.

sanity dataset copy --list

📓 Full changelog

🐛 Notable bugfixes

• Fixes issue where schema errors would not be displayed in error boundary
• Fixes reference inputs not showing create buttons in certain contexts
• Fixes a few unstyled UI elements using system default font
• Fixes change indicators not appearing in all contexts
• Fixes object input not respecting columns option

📓 Full changelog

Upgrade Sanity Studio with:

sanity upgrade

🐛 Notable bugfixes

• Fixes hovering issue in array input with portable text block
• Fixes issue where selected list ordering in desk structure would not be respected
• Fixes issue where document list appeared to be loading forever when changing the ordering
• Fixes issue where the the code input file name field would disappear when the language option was set
• Improves error message when copying a dataset and the target dataset already exists, but a copy operation is already in progress

📓 Full changelog