Installation and upgrading

To globally install/upgrade the v3 Sanity CLI:

npm install --global sanity@dev-preview

To validate you're on @3.0.0-rc.3:

$ sanity --version
> sanity version 3.0.0-rc.3

The new CLI should work with existing v2 studios, but you won't be able to initialize new v2 studios with it.

To initiate a new Studio without installing the CLI globally:

npx create-sanity@dev-preview

To upgrade a v3 Studio:

npm install sanity@3.0.0-rc.3

Make sure your package.json are up to date with these dependencies:

{
  "dependencies": {
    // if you’re depending on `@sanity/ui`
    "@sanity/ui": "^1.0.0",
    "sanity": "3.0.0-rc.3"
  }
}

Breaking changes

Client dropped from configuration context

Removed the client property from configuration context. Use getClient({apiVersion: '2022-06-07'}) or similar instead.

Configuration resolution order

The order in which defineConfig resolves workspace configuration has changed.

Plugin configurations are now resolved before the configuration provided to defineConfig is applied.

The basic principle is that the higher index a plugin has in the plugins array, the higher priority it has, because it can "overwrite" what previous plugins have configured, or choose to pass it on in the chain. Finally, the chain ends in the "root config" (i.e. in defineConfig) which gets to determine the final output.

Before:

export default defineConfig({
  // rest of config...

  tools: (prev) => {
    // prev = [] 

    return [...prev, toolFromConfig]
  },

  plugins: [
    toolPlugin1(), // prev = [toolFromConfig]
    toolPlugin2(), // prev = [toolFromConfig, toolFromPlugin1]
    toolPlugin3(), // prev = [toolFromConfig, toolFromPlugin1, toolFromPlugin2]
  ],
})

After:

export default defineConfig({
  // rest of config...

  tools: (prev) => {
    // prev = [toolFromPlugin1, toolFromPlugin2, toolFromPlugin3]

    return [...prev, toolFromConfig]
  },

  plugins: [
    toolPlugin1(), // prev = []
    toolPlugin2(), // prev = [toolFromPlugin1]
    toolPlugin3(), // prev = [toolFromPlugin1, toolFromPlugin2]
  ],
})

Renamed modal option in document actions

In document actions, modal has been renamed to dialog.

Before:

export const MyDocumentAction = () => {
  // ... rest of the code

  return {
    // ... rest of the code
    modal: ActionDialog, // <--- This is the old way of doing it
    icon: RocketIcon,
    label: 'My action',
  }
}

After:

export const MyDocumentAction = () => {
  // ... rest of the code

  return {
    // ... rest of the code
    dialog: ActionDialog, // <--- This is the new way of doing it
    icon: RocketIcon,
    label: 'My action',
  }
}

Notable bugfixes

• Fixes an issue causing numeric array items to disappear when clearing the input
• Fixes an issue with arrays rendering inside custom blocks
• Makes sure colors used in the review changes panel will adjust to dark mode
• Fixes an issue causing media previews to not work properly
• Fixes a edge case where a cross-dataset reference to a deleted document would prevent you changing the document with the reference
• Fixes UI issues related to adding annotations in the Portable Text Editor.

📓 Full changelog