Class MenuItemBuilder

Class for building menu items.

Implements

Serializable<MenuItem>

Index

Methods

action clone getAction getGroup getI18n getIcon getIntent getParams getShowAsAction getTitle group i18n icon intent params serialize showAsAction title

Methods

action

action(action: MenuItemActionType): MenuItemBuilder
Set menu item action
Parameters
- action: MenuItemActionType
  menu item action. See MenuItemActionType
Returns MenuItemBuilder
menu item builder based on action provided. See MenuItemBuilder
- Defined in packages/sanity/src/structure/structureBuilder/MenuItem.ts:94

clone

clone(withSpec?: Partial): MenuItemBuilder
Clone menu item builder
Parameters
- OptionalwithSpec: Partial
  menu item options. See PartialMenuItem
Returns MenuItemBuilder
menu item builder based on context and spec provided. See MenuItemBuilder
- Defined in packages/sanity/src/structure/structureBuilder/MenuItem.ts:267

getAction

getAction(): MenuItemActionType
Get menu item action

Returns MenuItemActionType
menu item builder action. See PartialMenuItem
- Defined in packages/sanity/src/structure/structureBuilder/MenuItem.ts:102

getGroup

getGroup(): string
Get menu item group

Returns string
menu item group. See PartialMenuItem
- Defined in packages/sanity/src/structure/structureBuilder/MenuItem.ts:171

getI18n

getI18n(): any
Get the i18n key and namespace used to populate the localized title.

Returns any
the i18n key and namespace used to populate the localized title.
- Defined in packages/sanity/src/structure/structureBuilder/MenuItem.ts:154

getIcon

getIcon(): ReactNode | ComponentType<{}>
Get menu item icon

Returns ReactNode | ComponentType<{}>
menu item icon. See PartialMenuItem
- Defined in packages/sanity/src/structure/structureBuilder/MenuItem.ts:188

getIntent

getIntent(): Intent
Get menu item intent

Returns Intent
menu item intent. See PartialMenuItem
- Defined in packages/sanity/src/structure/structureBuilder/MenuItem.ts:119

getParams

getParams(): MenuItemParamsType
Get meny item parameters

Returns MenuItemParamsType
menu item parameters. See PartialMenuItem
- Defined in packages/sanity/src/structure/structureBuilder/MenuItem.ts:205

getShowAsAction

getShowAsAction(): boolean
Check if menu item should show as action

Returns boolean
true if menu item should show as action, false if not. See PartialMenuItem
- Defined in packages/sanity/src/structure/structureBuilder/MenuItem.ts:222

getTitle

getTitle(): string
Get menu item title. Note that the i18n configuration will take precedence and this title is left here for compatibility.

Returns string
menu item title
- Defined in packages/sanity/src/structure/structureBuilder/MenuItem.ts:137

group

group(group: string): MenuItemBuilder
Set menu item group
Parameters
- group: string
  menu item group
Returns MenuItemBuilder
menu item builder based on group provided. See MenuItemBuilder
- Defined in packages/sanity/src/structure/structureBuilder/MenuItem.ts:163

i18n

i18n(i18n: I18nTextRecord<"title">): MenuItemBuilder
Set the i18n key and namespace used to populate the localized title.
Parameters
- i18n: I18nTextRecord<"title">
  object with i18n key and related namespace
Returns MenuItemBuilder
menu item builder based on i18n config provided. See MenuItemBuilder
- Defined in packages/sanity/src/structure/structureBuilder/MenuItem.ts:146

icon

icon(icon: ReactNode | ComponentType<{}>): MenuItemBuilder
Set menu item icon
Parameters
- icon: ReactNode | ComponentType<{}>
  menu item icon
Returns MenuItemBuilder
menu item builder based on icon provided. See MenuItemBuilder
- Defined in packages/sanity/src/structure/structureBuilder/MenuItem.ts:180

intent

intent(intent: Intent): MenuItemBuilder
Set menu item intent
Parameters
- intent: Intent
  menu item intent. See Intent
Returns MenuItemBuilder
menu item builder based on intent provided. See MenuItemBuilder
- Defined in packages/sanity/src/structure/structureBuilder/MenuItem.ts:111

params

params(params: MenuItemParamsType): MenuItemBuilder
Set menu item parameters
Parameters
- params: MenuItemParamsType
  menu item parameters. See MenuItemParamsType
Returns MenuItemBuilder
menu item builder based on parameters provided. See MenuItemBuilder
- Defined in packages/sanity/src/structure/structureBuilder/MenuItem.ts:197

serialize

serialize(options?: SerializeOptions): MenuItem
Serialize menu item builder
Parameters
- options: SerializeOptions = ...
  serialization options. See SerializeOptions
Returns MenuItem
menu item node based on path provided in options. See MenuItem
Implementation of Serializable.serialize
- Defined in packages/sanity/src/structure/structureBuilder/MenuItem.ts:230

showAsAction

showAsAction(showAsAction?: boolean): MenuItemBuilder
Set menu item to show as action
Parameters
- showAsAction: boolean = true
  determine if menu item should show as action
Returns MenuItemBuilder
menu item builder based on if it should show as action. See MenuItemBuilder
- Defined in packages/sanity/src/structure/structureBuilder/MenuItem.ts:214

title

title(title: string): MenuItemBuilder
Set menu item title
Parameters
- title: string
  menu item title
Returns MenuItemBuilder
menu item builder based on title provided. See MenuItemBuilder
- Defined in packages/sanity/src/structure/structureBuilder/MenuItem.ts:128