Interface MynahUIDataModel

data store model to update the mynah ui partially or fully

interface MynahUIDataModel {
    cancelButtonWhenLoading?: boolean;
    chatItems?: ChatItem[];
    compactMode?: boolean;
    contextCommands?: QuickActionCommandGroup[];
    loadingChat?: boolean;
    pinned?: boolean;
    promptInputDisabledState?: boolean;
    promptInputInfo?: string;
    promptInputLabel?: null | string;
    promptInputOptions?: null | ChatItemFormItem[];
    promptInputPlaceholder?: string;
    promptInputProgress?: null | ProgressField;
    promptInputStickyCard?: null | Partial<ChatItem>;
    promptInputText?: string;
    promptInputVisible?: boolean;
    quickActionCommands?: QuickActionCommandGroup[];
    selectedCodeSnippet?: string;
    showChatAvatars?: boolean;
    tabBackground?: boolean;
    tabBarButtons?: TabBarMainAction[];
    tabCloseConfirmationCloseButton?: null | string;
    tabCloseConfirmationKeepButton?: null | string;
    tabCloseConfirmationMessage?: null | string;
    tabHeaderDetails?: null | TabHeaderDetails;
    tabIcon?: null | MynahIcons | "q" | "menu" | "minus" | "search" | "plus" | "paper-clip" | "list-add" | "tabs" | "chat" | "link" | "folder" | "file" | "flash" | "doc" | "external" | "cancel" | "cancel-circle" | "calendar" | "comment" | "megaphone" | "magic" | "notification" | "eye" | "ellipsis" | "ok" | "up-open" | "down-open" | "right-open" | "left-open" | "resize-full" | "resize-small" | "block" | "ok-circled" | "info" | "warning" | "error" | "thumbs-up" | "thumbs-down" | "star" | "stack" | "light-bulb" | "envelope-send" | "refresh" | "progress" | "scroll-down" | "user" | "play" | "pause" | "stop" | "pencil" | "code-block" | "copy" | "cursor-insert" | "text-select" | "revert" | "rocket" | "asterisk" | "bug" | "check-list" | "deploy" | "help" | "message" | "trash" | "transform";
    tabMetadata?: {
        [key: string]: string | boolean | number;
    };
    tabTitle?: string;
}

Properties

cancelButtonWhenLoading? chatItems? compactMode? contextCommands? loadingChat? pinned? promptInputDisabledState? promptInputInfo? promptInputLabel? promptInputOptions? promptInputPlaceholder? promptInputProgress? promptInputStickyCard? promptInputText? promptInputVisible? quickActionCommands? selectedCodeSnippet? showChatAvatars? tabBackground? tabBarButtons? tabCloseConfirmationCloseButton? tabCloseConfirmationKeepButton? tabCloseConfirmationMessage? tabHeaderDetails? tabIcon? tabMetadata? tabTitle?

Properties

Optional cancelButtonWhenLoading

cancelButtonWhenLoading?: boolean

Show cancel button while loading the chat

Optional chatItems

chatItems?: ChatItem[]

List of chat item objects to be shown on the web suggestions search screen

Optional compactMode

compactMode?: boolean

Tab content compact mode which keeps everything in the middle

Optional contextCommands

contextCommands?: QuickActionCommandGroup[]

Context commands to show when user hits @ to the input any point

Optional loadingChat

loadingChat?: boolean

Chat screen loading animation state (mainly use during the stream or getting the initial answer)

Optional pinned

pinned?: boolean

is tab pinned

Optional promptInputDisabledState

promptInputDisabledState?: boolean

Prompt input field disabled state, set to tru to disable it

Optional promptInputInfo

promptInputInfo?: string

Info block to be shown under prompt input

Optional promptInputLabel

promptInputLabel?: null | string

Label to be shown on top of the prompt input

Optional promptInputOptions

promptInputOptions?: null | ChatItemFormItem[]

Prompt input options/form items

Optional promptInputPlaceholder

promptInputPlaceholder?: string

Placeholder to be shown on prompt input

Optional promptInputProgress

promptInputProgress?: null | ProgressField

Prompt input progress field

Optional promptInputStickyCard

promptInputStickyCard?: null | Partial<ChatItem>

A sticky chat item card on top of the prompt input

Optional promptInputText

promptInputText?: string

Prompt input text

Optional promptInputVisible

promptInputVisible?: boolean

Label to be shown on top of the prompt input

Optional quickActionCommands

quickActionCommands?: QuickActionCommandGroup[]

Quick Action commands to show when user hits / to the input initially

Optional selectedCodeSnippet

selectedCodeSnippet?: string

Attached code under the prompt input field

Optional showChatAvatars

showChatAvatars?: boolean

Show chat avatars or not

Optional tabBackground

tabBackground?: boolean

Tab title

Optional tabBarButtons

tabBarButtons?: TabBarMainAction[]

Tab bar buttons next to the tab items

Optional tabCloseConfirmationCloseButton

tabCloseConfirmationCloseButton?: null | string

Close tab button text

Optional tabCloseConfirmationKeepButton

tabCloseConfirmationKeepButton?: null | string

Keep tab open button text

Optional tabCloseConfirmationMessage

tabCloseConfirmationMessage?: null | string

If tab is running an action (loadingChat = true) this markdown will be shown before close in a popup

Optional tabHeaderDetails

tabHeaderDetails?: null | TabHeaderDetails

Tab content header details, only visibile when showTabHeaderDetails is set to 'true'

Optional tabIcon

tabIcon?: null | MynahIcons | "q" | "menu" | "minus" | "search" | "plus" | "paper-clip" | "list-add" | "tabs" | "chat" | "link" | "folder" | "file" | "flash" | "doc" | "external" | "cancel" | "cancel-circle" | "calendar" | "comment" | "megaphone" | "magic" | "notification" | "eye" | "ellipsis" | "ok" | "up-open" | "down-open" | "right-open" | "left-open" | "resize-full" | "resize-small" | "block" | "ok-circled" | "info" | "warning" | "error" | "thumbs-up" | "thumbs-down" | "star" | "stack" | "light-bulb" | "envelope-send" | "refresh" | "progress" | "scroll-down" | "user" | "play" | "pause" | "stop" | "pencil" | "code-block" | "copy" | "cursor-insert" | "text-select" | "revert" | "rocket" | "asterisk" | "bug" | "check-list" | "deploy" | "help" | "message" | "trash" | "transform"

Tab icon

Optional tabMetadata

tabMetadata?: {
    [key: string]: string | boolean | number;
}

A lightweight key-value store for essential tab-specific primitive metadata. Not intended for storing large amounts of data - use appropriate application state management for that purpose.

Type declaration

  • [key: string]: string | boolean | number

Optional tabTitle

tabTitle?: string

Tab title

Settings

Member Visibility

Theme

On This Page

cancelButtonWhenLoadingchatItemscompactModecontextCommandsloadingChatpinnedpromptInputDisabledStatepromptInputInfopromptInputLabelpromptInputOptionspromptInputPlaceholderpromptInputProgresspromptInputStickyCardpromptInputTextpromptInputVisiblequickActionCommandsselectedCodeSnippetshowChatAvatarstabBackgroundtabBarButtonstabCloseConfirmationCloseButtontabCloseConfirmationKeepButtontabCloseConfirmationMessagetabHeaderDetailstabIcontabMetadatatabTitle