MenuItem
Class: MenuItem
Section titled “Class: MenuItem”Defined in: menu.svelte.ts:23
Properties
Section titled “Properties”[MENU_ITEM_TAG]
Section titled “[MENU_ITEM_TAG]”
readonly[MENU_ITEM_TAG]:true=true
Defined in: menu.svelte.ts:24
readonlymenu:Menu
Defined in: menu.svelte.ts:75
Accessors
Section titled “Accessors”checked
Section titled “checked”Get Signature
Section titled “Get Signature”get checked():
boolean|null
Defined in: menu.svelte.ts:50
Returns
Section titled “Returns”boolean | null
disabled
Section titled “disabled”Get Signature
Section titled “Get Signature”get disabled():
boolean
Defined in: menu.svelte.ts:54
Returns
Section titled “Returns”boolean
Get Signature
Section titled “Get Signature”get icon():
string|null
Defined in: menu.svelte.ts:46
Returns
Section titled “Returns”string | null
isLabel
Section titled “isLabel”Get Signature
Section titled “Get Signature”get isLabel():
boolean
Defined in: menu.svelte.ts:58
Returns
Section titled “Returns”boolean
section
Section titled “section”Get Signature
Section titled “Get Signature”get section():
string
Defined in: menu.svelte.ts:38
Returns
Section titled “Returns”string
Get Signature
Section titled “Get Signature”get title():
string|DocumentFragment
Defined in: menu.svelte.ts:42
Returns
Section titled “Returns”string | DocumentFragment
Methods
Section titled “Methods”click()
Section titled “click()”click(
evt):any
Defined in: menu.svelte.ts:62
Parameters
Section titled “Parameters”MouseEvent | KeyboardEvent
Returns
Section titled “Returns”any
onClick()
Section titled “onClick()”onClick(
callback):this
Defined in: menu.svelte.ts:115
Parameters
Section titled “Parameters”callback
Section titled “callback”(evt) => any
Returns
Section titled “Returns”this
setChecked()
Section titled “setChecked()”setChecked(
checked):this
Defined in: menu.svelte.ts:94
Parameters
Section titled “Parameters”checked
Section titled “checked”boolean | null
Returns
Section titled “Returns”this
setDisabled()
Section titled “setDisabled()”setDisabled(
disabled):this
Defined in: menu.svelte.ts:99
Parameters
Section titled “Parameters”disabled
Section titled “disabled”boolean
Returns
Section titled “Returns”this
setIcon()
Section titled “setIcon()”setIcon(
icon):this
Defined in: menu.svelte.ts:88
Parameters
Section titled “Parameters”string | null
ID of the icon, can use any icon loaded with addIcon or from the built-in lucide library.
Returns
Section titled “Returns”this
The Obsidian icon library includes the Lucide icon library, any icon name from their site will work here.
setIsLabel()
Section titled “setIsLabel()”setIsLabel(
isLabel):this
Defined in: menu.svelte.ts:109
Parameters
Section titled “Parameters”isLabel
Section titled “isLabel”boolean
Returns
Section titled “Returns”this
setSection()
Section titled “setSection()”setSection(
section):this
Defined in: menu.svelte.ts:130
Sets the section this menu item should belong in. To find the section IDs
of an existing menu, inspect the DOM elements to see their data-section
attribute.
Parameters
Section titled “Parameters”section
Section titled “section”string
Returns
Section titled “Returns”this
setTitle()
Section titled “setTitle()”setTitle(
title):this
Defined in: menu.svelte.ts:78
Parameters
Section titled “Parameters”string | DocumentFragment
Returns
Section titled “Returns”this
setWarning()
Section titled “setWarning()”setWarning(
warning?):this
Defined in: menu.svelte.ts:104
Parameters
Section titled “Parameters”warning?
Section titled “warning?”boolean = true
Returns
Section titled “Returns”this
create()
Section titled “create()”
staticcreate(menu):MenuItem
Defined in: menu.svelte.ts:66
Parameters
Section titled “Parameters”Returns
Section titled “Returns”MenuItem