Class MynahUI

Constructors

constructor

new MynahUI(props): MynahUI
Parameters
- props: MynahUIProps
Returns MynahUI
- Defined in src/main.ts:355

Properties

`Private` `Readonly` chatWrappers

chatWrappers: Record<string, ChatWrapper> = {}

`Private` `Optional` `Readonly` feedbackForm

feedbackForm?: FeedbackForm

`Private` lastEventId

lastEventId: string = ''

`Private` `Readonly` props

props: MynahUIProps

`Private` `Readonly` render

render: ExtendedHTMLElement

`Private` `Optional` `Readonly` sheet

sheet?: Sheet

`Private` `Readonly` splashLoader

splashLoader: ExtendedHTMLElement

`Private` `Readonly` splashLoaderActions

splashLoaderActions: ExtendedHTMLElement

`Private` `Readonly` splashLoaderText

splashLoaderText: ExtendedHTMLElement

`Private` `Readonly` tabContentsWrapper

tabContentsWrapper: ExtendedHTMLElement

`Private` `Readonly` tabsWrapper

tabsWrapper: ExtendedHTMLElement

Methods

addChatItem

addChatItem(tabId, chatItem): void
Adds a new item to the chat window
Parameters
- tabId: string
  Corresponding tab ID.
- chatItem: ChatItem
Returns void
- Defined in src/main.ts:892

addCustomContextToPrompt

addCustomContextToPrompt(tabId, contextItem, insertPosition?): void
Parameters
- tabId: string
- contextItem: QuickActionCommand[]
- Optional insertPosition: number
Returns void
- Defined in src/main.ts:904

`Private` `Readonly` addGlobalListeners

addGlobalListeners(): void
Returns void
- Defined in src/main.ts:537

addToUserPrompt

addToUserPrompt(tabId, attachmentContent, type?): void
Parameters
- tabId: string
- attachmentContent: string
- Optional type: PromptAttachmentType
Returns void
- Defined in src/main.ts:881

destroy

destroy(): void
Returns void
- Defined in src/main.ts:1211

endMessageStream

endMessageStream(tabId, messageId, updateWith?): CardRenderDetails
Converts a card to an ANSWER if it is an ANSWER_STREAM
Parameters
- tabId: string
  Corresponding tab ID.
- messageId: string
  Corresponding tab ID.
- Optional updateWith: Partial<ChatItem>
  Optional, if you like update the card while converting it to a normal ANSWER instead of a stream one, you can send a ChatItem object to update with.
Returns CardRenderDetails
- Defined in src/main.ts:984

`Private` `Readonly` focusToInput

focusToInput(tabId): void
Parameters
- tabId: string
Returns void
- Defined in src/main.ts:531

getAllTabs

getAllTabs(): MynahUITabStoreModel
Returns all tabs with their store information

Returns MynahUITabStoreModel
string selectedTabId or undefined
- Defined in src/main.ts:1070

getSelectedTabId

getSelectedTabId(): undefined | string
This function returns the selected tab id if there is any, otherwise returns undefined

Returns undefined | string
string selectedTabId or undefined
- Defined in src/main.ts:1061

`Private` `Readonly` getSplashLoaderActions

getSplashLoaderActions(actions?): ExtendedHTMLElement[]
Parameters
- Optional actions: Action[]
Returns ExtendedHTMLElement[]
- Defined in src/main.ts:511

getTabData

getTabData(tabId): MynahUIDataStore
Parameters
- tabId: string
Returns MynahUIDataStore
- Defined in src/main.ts:1072

getTabDefaults

getTabDefaults(): MynahUITabStoreTab
Updates defaults of the tab store

Returns MynahUITabStoreTab
- Defined in src/main.ts:1053

`Private` `Readonly` getUserEventId

getUserEventId(): string
Returns string
- Defined in src/main.ts:526

notify

notify(props): void
Simply creates and shows a notification
Parameters
- props: {
      content: string;
      duration?: number;
      onNotificationClick?: ((eventId) => void);
      onNotificationHide?: ((eventId) => void);
      title?: string;
      type?: NotificationType;
  }
  NotificationProps
  - content: string
  - Optional duration?: number
    -1 for infinite
  - Optional onNotificationClick?: ((eventId) => void)
    - (eventId): void
      Parameters
      eventId: string
      Returns void
  - Optional onNotificationHide?: ((eventId) => void)
    - (eventId): void
      Parameters
      eventId: string
      Returns void
  - Optional title?: string
  - Optional type?: NotificationType
Returns void
- Defined in src/main.ts:1119

openDetailedList

openDetailedList(data, showBackButton?): {
    changeTarget: ((direction, snapOnLastAndFirst?) => void);
    close: (() => void);
    getTargetElementId: (() => undefined | string);
    update: ((data, showBackButton?) => void);
}
Parameters
- data: DetailedListSheetProps
- Optional showBackButton: boolean
Returns {
    changeTarget: ((direction, snapOnLastAndFirst?) => void);
    close: (() => void);
    getTargetElementId: (() => undefined | string);
    update: ((data, showBackButton?) => void);
}
- changeTarget: ((direction, snapOnLastAndFirst?) => void)
  - - (direction, snapOnLastAndFirst?): void
    - Parameters
      direction: "up" | "down"
      Optional snapOnLastAndFirst: boolean
      Returns void
- close: (() => void)
  - - (): void
    - Returns void
- getTargetElementId: (() => undefined | string)
  - - (): undefined | string
    - Returns undefined | string
- update: ((data, showBackButton?) => void)
  - - (data, showBackButton?): void
    - Parameters
      data: DetailedList
      Optional showBackButton: boolean
      Returns void
- Defined in src/main.ts:1184

openTopBarButtonOverlay

openTopBarButtonOverlay(data): {
close: (() => void);
update: ((data) => void);
}
Parameters
- data: TopBarButtonOverlayProps
Returns {
close: (() => void);
update: ((data) => void);
}
- close: (() => void)
  - - (): void
    - Returns void
- update: ((data) => void)
  - - (data): void
    - Parameters
      data: DetailedList
      Returns void
- Defined in src/main.ts:1169

removeTab

removeTab(tabId, eventId): void
If exists, close the given tab
Parameters
- tabId: string
  Tab ID to switch to
- eventId: string
  last action's user event ID passed from an event binded to mynahUI. Without user intent you cannot switch to a different tab
Returns void
- Defined in src/main.ts:1020

resetTopBarClicked

resetTopBarClicked(tabId): void
Programmatically resets topBarClicked for the specified tab by dispatching a RESET_TOP_BAR_CLICKED event.
Parameters
- tabId: string
  The tab ID
Returns void
- Defined in src/main.ts:1089

selectTab

selectTab(tabId, eventId?): void
If exists, switch to a different tab
Parameters
- tabId: string
  Tab ID to switch to
- Optional eventId: string
  last action's user event ID passed from an event binded to mynahUI. Without user intent you cannot switch to a different tab
Returns void
- Defined in src/main.ts:1006

serializeChat

serializeChat(tabId, format): string
Serialize all (non-empty) chat messages in a tab into a string
Parameters
- tabId: string
  Corresponding tab ID.
- format: "html" | "markdown"
  Whether to serialize to markdown or HTML format
Returns string
- Defined in src/main.ts:970

setDragOverlayVisible

setDragOverlayVisible(tabId, visible): void
Sets the drag overlay visibility for a specific tab
Parameters
- tabId: string
  The tab ID to set the drag overlay visibility for
- visible: boolean
  Whether the drag overlay should be visible
Returns void
- Defined in src/main.ts:1079

showCustomForm

showCustomForm(tabId, formItems?, buttons?, title?, description?): void
Simply creates and shows a custom form
Parameters
- tabId: string
- Optional formItems: ChatItemFormItem[]
- Optional buttons: ChatItemButton[]
- Optional title: string
- Optional description: string
Returns void
- Defined in src/main.ts:1152

toggleSplashLoader

toggleSplashLoader(visible, text?, actions?): void
Toggles the visibility of the splash loader screen
Parameters
- visible: boolean
- Optional text: string
- Optional actions: Action[]
Returns void
- Defined in src/main.ts:1096

updateChatAnswerWithMessageId

updateChatAnswerWithMessageId(tabId, messageId, updateWith): void
Updates the chat item with the given messageId
Parameters
- tabId: string
  Corresponding tab ID.
- messageId: string
  Corresponding tab ID.
- updateWith: Partial<ChatItem>
  ChatItem object to update with.
Returns void
- Defined in src/main.ts:959

updateLastChatAnswer

updateLastChatAnswer(tabId, updateWith): void
Updates the last ChatItemType.ANSWER_STREAM chat item
Parameters
- tabId: string
  Corresponding tab ID.
- updateWith: Partial<ChatItem>
  ChatItem object to update with.
Returns void
- Defined in src/main.ts:936

updateStore

updateStore(tabId, data): undefined | string
Updates only the UI with the given data for the given tab Send tab id as an empty string to open a new tab! If max tabs reached, will not return tabId
Parameters
- tabId: string
- data: MynahUIDataModel
  A full or partial set of data with values.
Returns undefined | string
- Defined in src/main.ts:1032

updateTabDefaults

updateTabDefaults(defaults): void
Updates defaults of the tab store
Parameters
- defaults: MynahUITabStoreTab
  MynahUITabStoreTab
Returns void
- Defined in src/main.ts:1045

Class MynahUI

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MynahUI

Properties

Private Readonly chatWrappers

Private Optional Readonly feedbackForm

Private lastEventId

Private Readonly props

Private Readonly render

Private Optional Readonly sheet

Private Readonly splashLoader

Private Readonly splashLoaderActions

Private Readonly splashLoaderText

Private Readonly tabContentsWrapper

Private Readonly tabsWrapper

Methods

addChatItem

Parameters

Returns void

addCustomContextToPrompt

Parameters

Returns void

Private Readonly addGlobalListeners

Returns void

addToUserPrompt

Parameters

Returns void

destroy

Returns void

endMessageStream

Parameters

Returns CardRenderDetails

Private Readonly focusToInput

Parameters

Returns void

getAllTabs

Returns MynahUITabStoreModel

getSelectedTabId

Returns undefined | string

Private Readonly getSplashLoaderActions

Parameters

Returns ExtendedHTMLElement[]

getTabData

Parameters

Returns MynahUIDataStore

getTabDefaults

Returns MynahUITabStoreTab

Private Readonly getUserEventId

Returns string

notify

Parameters

content: string

Optional duration?: number

Optional onNotificationClick?: ((eventId) => void)

Parameters

Returns void

Optional onNotificationHide?: ((eventId) => void)

Parameters

Returns void

Optional title?: string

Optional type?: NotificationType

Returns void

openDetailedList

Parameters

Returns { changeTarget: ((direction, snapOnLastAndFirst?) => void); close: (() => void); getTargetElementId: (() => undefined | string); update: ((data, showBackButton?) => void); }

changeTarget: ((direction, snapOnLastAndFirst?) => void)

Parameters

Returns void

close: (() => void)

Returns void

getTargetElementId: (() => undefined | string)

Returns undefined | string

update: ((data, showBackButton?) => void)

Parameters

`Private` `Readonly` chatWrappers

`Private` `Optional` `Readonly` feedbackForm

`Private` lastEventId

`Private` `Readonly` props

`Private` `Readonly` render

`Private` `Optional` `Readonly` sheet

`Private` `Readonly` splashLoader

`Private` `Readonly` splashLoaderActions

`Private` `Readonly` splashLoaderText

`Private` `Readonly` tabContentsWrapper

`Private` `Readonly` tabsWrapper

`Private` `Readonly` addGlobalListeners

`Private` `Readonly` focusToInput

`Private` `Readonly` getSplashLoaderActions

`Private` `Readonly` getUserEventId

`Optional` duration?: number

`Optional` onNotificationClick?: ((eventId) => void)

`Optional` onNotificationHide?: ((eventId) => void)

`Optional` title?: string

`Optional` type?: NotificationType

Returns {
changeTarget: ((direction, snapOnLastAndFirst?) => void);
close: (() => void);
getTargetElementId: (() => undefined | string);
update: ((data, showBackButton?) => void);
}

Returns {
close: (() => void);
update: ((data) => void);
}