sanity-plugin-authoring

Create a Sanity Studio plugin by calling definePlugin with a stable unique name and a configuration object covering properties like document, form, tools, or schema. Register it in the Studio's plugins array to activate it.

Pass a function to definePlugin that accepts an options object and returns the plugin configuration. Prefer extensible object shapes like {feature: {enabled: true}} over direct booleans so future settings can be added without breaking changes.

Plugins can provide document actions and badges, form customizations, nested plugins, tools, schema types, studio component overrides, i18n bundles, a title, and onUncaughtError handlers. They cannot set workspace-owned settings like dataset, projectId, auth, or theme.

Add the tool through the plugin's tools property with a stable name, title, component, and router when needed. Visual order follows tool registration order, and changing the default opened tool requires the top-level tools reducer pattern.

Define an i18n locale resource bundle with a namespace, locale, and lazy resources import, then register it in the plugin's i18n.bundles array. This avoids hard-coding user-facing strings in plugin components.