Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(structure): add ability to override the tool's canHandleIntent logic #7611

Open
wants to merge 1 commit into
base: next
Choose a base branch
from
Open

feat(structure): add ability to override the tool's canHandleIntent logic #7611

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions packages/sanity/src/structure/structureTool.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,11 +106,7 @@ export const structureTool = definePlugin<StructureToolOptions | void>((options)
title: options?.title || 'Structure',
icon,
component: lazy(() => import('./components/structureTool')),
canHandleIntent: (intent, params) => {
if (intent === 'create') return canHandleCreateIntent(params)
if (intent === 'edit') return canHandleEditIntent(params)
return false
},
canHandleIntent: options?.canHandleIntent || canHandleIntent,
getIntentState,
// Controlled by sanity/src/structure/components/structureTool/StructureTitle.tsx
controlsDocumentTitle: true,
Expand All @@ -125,6 +121,18 @@ export const structureTool = definePlugin<StructureToolOptions | void>((options)
}
})

/**
* The default implementation of the `canHandleIntent` function for the Structure Tool.
*/
export function canHandleIntent(
intent: string,
params: Record<string, unknown>,
): boolean | {[key: string]: boolean} {
if (intent === 'create') return canHandleCreateIntent(params)
if (intent === 'edit') return canHandleEditIntent(params)
return false
}

function canHandleCreateIntent(params: Record<string, unknown>) {
// We can't handle create intents without a `type` parameter
if (!('type' in params)) {
Expand Down
22 changes: 22 additions & 0 deletions packages/sanity/src/structure/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
type I18nTextRecord,
type InitialValueTemplateItem,
type LocaleSource,
type Tool,
} from 'sanity'

import {
Expand Down Expand Up @@ -147,6 +148,27 @@ export interface StructureToolOptions {
* The title that will be displayed for the tool. Defaults to Structure
*/
title?: string
/**
* Determines whether the tool can handle the given intent.
* By default, the Structure tool can handle create and edit intents for all document types.
* This function can be used to override this behavior; for example you could have multiple
* Structure tools in the same workspace, each handling intents for different document types.
*
* @example
* ```ts
* // This Structure Tool only wants to handle intents for "author" documents
* structureTool({
* title: 'Authors',
* name: 'authors',
* canHandleIntent: (intent, params) => {
* if (params.type !== 'author') return false
*
* return canHandleIntent(intent, params)
* },
* })
* ```
*/
canHandleIntent?: Tool['canHandleIntent']
}

/**
Expand Down