Interface: IUiApi
Defined in: Extensions/ExtensionApiTypes.ts:339
Methods
pickFile()
pickFile(
opts?):Promise<PickedFileDto|undefined>
Defined in: Extensions/ExtensionApiTypes.ts:406
Open the system file picker for the user to choose a file. Requires
fs:read-user. The host returns the file contents (not the path) so the
extension never sees absolute paths.
Parameters
opts?
Returns
Promise<PickedFileDto | undefined>
registerContextMenu()
registerContextMenu(
target,item):Promise<DisposableHandle>
Defined in: Extensions/ExtensionApiTypes.ts:361
Add an item to a built-in context menu.
Parameters
target
item
Returns
Promise<DisposableHandle>
registerDisplayMode()
registerDisplayMode(
def):Promise<DisposableHandle>
Defined in: Extensions/ExtensionApiTypes.ts:373
Contribute a custom verse display mode. Appears in the Bible pane's
Display Mode picker alongside Simple/Standard/Study. The host calls
renderEndpoint for each visible verse, and the extension returns
either decorations to overlay on the standard rendering, or an iframe
URL to fully replace the verse's rendering.
Parameters
def
Returns
Promise<DisposableHandle>
registerPanelType()
registerPanelType(
def):Promise<DisposableHandle>
Defined in: Extensions/ExtensionApiTypes.ts:341
Contribute a new panel/content type.
Parameters
def
Returns
Promise<DisposableHandle>
registerStatusBarItem()
registerStatusBarItem(
item):Promise<DisposableHandle>
Defined in: Extensions/ExtensionApiTypes.ts:379
Contribute a status bar item. Useful for "X items indexed", "Connected to logos.com", etc.
Parameters
item
Returns
Promise<DisposableHandle>
registerVerseDecorator()
registerVerseDecorator(
d):Promise<DisposableHandle>
Defined in: Extensions/ExtensionApiTypes.ts:344
Contribute a verse decorator.
Parameters
d
Returns
Promise<DisposableHandle>
registerVerseHover()
registerVerseHover(
h):Promise<DisposableHandle>
Defined in: Extensions/ExtensionApiTypes.ts:356
Contribute hover content for verses.
Parameters
h
Returns
Promise<DisposableHandle>
saveFile()
saveFile(
content,opts?):Promise<boolean>
Defined in: Extensions/ExtensionApiTypes.ts:409
Open the system save picker. Requires fs:write-user.
Parameters
content
string | ArrayBuffer | Uint8Array<ArrayBufferLike>
opts?
Returns
Promise<boolean>
showConfirm()
showConfirm(
opts):Promise<boolean>
Defined in: Extensions/ExtensionApiTypes.ts:399
Show a modal confirm dialog.
Parameters
opts
Returns
Promise<boolean>
showInputBox()
showInputBox(
opts):Promise<string|undefined>
Defined in: Extensions/ExtensionApiTypes.ts:396
Show a single-line input prompt.
Parameters
opts
Returns
Promise<string | undefined>
showNotification()
showNotification(
msg,opts?):Promise<void>
Defined in: Extensions/ExtensionApiTypes.ts:384
Show a non-modal toast.
Parameters
msg
opts?
Returns
Promise<void>
showQuickPick()
showQuickPick<
T>(items,opts?):Promise<T|undefined>
Defined in: Extensions/ExtensionApiTypes.ts:390
Show a quick-pick prompt. The promise resolves with the user's selection or undefined.
Type Parameters
T
T
Parameters
items
opts?
Returns
Promise<T | undefined>
updateVerseDecorations()
updateVerseDecorations(
groupId,decorations):Promise<void>
Defined in: Extensions/ExtensionApiTypes.ts:350
Update an existing decoration group (matched by groupId). Use this when
data behind a decoration changes — e.g. a stemming overlay rebuilds.
Parameters
groupId
string
decorations
Returns
Promise<void>