Theia API Documentation v1.69.0
    Preparing search index...

    Class AskAIInputWidget

    React input widget for Ask AI functionality, extending the AIChatInputWidget.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _branch? _chatModel _initialValue? _onCancel _onDeleteChangeSet _onDeleteChangeSetElement _onQuery _onUnpin _pinnedAgent agentNotificationService aiActivationService applicationShell args availableGenericCapabilities capabilitiesOpen capabilitiesService capabilityDefaults changeSetActionService changeSetDecoratorService chatAgentService chatInputFirstLineKey chatInputFocusKey chatInputFocusService chatInputHasModesKey chatInputLastLineKey chatInputReceivingAgentKey chatRequestParser chatService configuration contextKeyService contextMenuRenderer contextVariablePicker disabledGenericCapabilities editorProvider editorReady editorRef fileValidationState forceCapabilitiesRefresh genericCapabilitiesService genericCapabilitySelections handleCapabilityChange handleGenericCapabilityChange handleModeChange heightInLines historyService hoverService isEnabled keybindingRegistry labelProvider navigationState node nodeRoot onDidChangeVisibility onDidChangeVisibilityEmitter onDidDispose onDidDisposeEmitter onDidResize onDidResizeEmitter onDisposeForChatModel onScrollUp onScrollUpEmitter onScrollYReachEnd onScrollYReachEndEmitter openerService pendingImageDisposables pendingImageRegistry queryInFlight receivingAgent resourceId resources scrollBar? scrollOptions? toDispose toDisposeOnDetach updateReceivingAgentTimeout userCapabilityOverrides validationService variableService CONTEXT_MENU ID

    Accessors

    branch chatModel dataset disposed editor hiddenMode id initialValue inputConfiguration isAttached isDisposed isHidden isVisible layout onCancel onDeleteChangeSet onDeleteChangeSetElement onQuery onUnpin parent pinnedAgent title

    Methods

    activate addClass addClipboardListener addContext addContextElement addEventListener addKeyListener addUpdateListener children clearFlag clearPendingImageAttachments close contains cycleMode deleteContextElement disableScrollBarFocus dispose fit focusChatSession getAllVariablesForRequest getCapabilitiesKeybindingHint getContext getImageBaseName getKeybindingHint getLastCapabilityOverridesFromModel getLastGenericCapabilitySelectionsFromModel getModeKeybindingHint getNextPrompt getPreviewNode getPreviousPrompt getResourceUri getScopeUri getScrollContainer handleAgentCompletion handleCancel handleContextMenu handleSubmit handleVisiblityChanged hasClass hide init initializeContextKeys isChatSessionFocused notifyLayout onActivateRequest onAfterAttach onAfterDetach onAfterHide onAfterShow onBeforeAttach onBeforeDetach onBeforeHide onBeforeShow onChildAdded onChildRemoved onCloseRequest onDragOver onDrop onEscape onFitRequest onPaste onResize onUpdateRequest openContextElement processMessage refreshCapabilities registerPendingImage removeClass render resolveAgentFromParsedRequest scheduleUpdateReceivingAgent setEnabled setFlag setHidden setupEditorEventListeners show testFlag toggleCapabilities toggleClass update updateAgentState updateAvailableGenericCapabilities updateCapabilitiesForAgent updateCursorPositionKeys updateReceivingAgent

    Constructors

    Properties

    Protected Optional_branch

    _branch?: ChatHierarchyBranch<ChatRequestModel>

    Protected_chatModel

    _chatModel: ChatModel

    Protected Optional_initialValue

    _initialValue?: string

    Protected_onCancel

    _onCancel: Cancel

    Protected_onDeleteChangeSet

    _onDeleteChangeSet: DeleteChangeSet

    Protected_onDeleteChangeSetElement

    _onDeleteChangeSetElement: DeleteChangeSetElement

    Protected_onQuery

    _onQuery: Query

    Protected_onUnpin

    _onUnpin: Unpin

    Protected_pinnedAgent

    _pinnedAgent: undefined | ChatAgent
    agentNotificationService: AgentCompletionNotificationService
    aiActivationService: AIActivationService
    applicationShell: ApplicationShell
    args: undefined | AskAIInputArgs
    availableGenericCapabilities: AvailableGenericCapabilities

    Available generic capabilities from all sources.

    capabilitiesOpen: boolean
    capabilitiesService: ChatCapabilitiesService
    capabilityDefaults: ParsedCapability[]

    Tracks the default enabled state for each capability. This is initialized from the agent's capabilities and used to display the initial chip state.

    changeSetActionService: ChangeSetActionService
    changeSetDecoratorService: ChangeSetDecoratorService
    chatAgentService: ChatAgentService
    chatInputFirstLineKey: ContextKey<boolean>
    chatInputFocusKey: ContextKey<boolean>
    chatInputFocusService: ChatInputFocusService
    chatInputHasModesKey: ContextKey<boolean>
    chatInputLastLineKey: ContextKey<boolean>
    chatInputReceivingAgentKey: ContextKey<string>
    chatRequestParser: ChatRequestParser
    chatService: ChatService
    configuration: undefined | AskAIInputConfiguration
    contextKeyService: ContextKeyService
    contextMenuRenderer: ContextMenuRenderer
    contextVariablePicker: ContextVariablePicker
    disabledGenericCapabilities: GenericCapabilitySelections

    Generic capabilities that are already used in the agent's prompt (should be disabled).

    editorProvider: MonacoEditorProvider
    editorReady: Deferred<void>
    editorRef: undefined | SimpleMonacoEditor
    fileValidationState: Map<string, FileValidationResult>
    forceCapabilitiesRefresh: boolean
    genericCapabilitiesService: undefined | GenericCapabilitiesService
    genericCapabilitySelections: GenericCapabilitySelections

    Tracks user's generic capability selections from the dropdowns.

    handleCapabilityChange: (fragmentId: string, enabled: boolean) => void
    handleGenericCapabilityChange: (
        type: keyof GenericCapabilitySelections,
        ids: string[],
    ) => void
    handleModeChange: (mode: string) => Promise<void>
    heightInLines: number = 3
    historyService: ChatInputHistoryService
    hoverService: HoverService
    isEnabled: boolean
    keybindingRegistry: KeybindingRegistry
    labelProvider: LabelProvider
    navigationState: ChatInputNavigationState
    node: HTMLElement

    Get the DOM node owned by the widget.

    nodeRoot: Root
    onDidChangeVisibility: Event<boolean>
    onDidChangeVisibilityEmitter: Emitter<boolean>
    onDidDispose: Event<void>
    onDidDisposeEmitter: Emitter<void>
    onDidResize: Event<void>
    onDidResizeEmitter: Emitter<void>
    onDisposeForChatModel: DisposableCollection
    onScrollUp: Event<void>
    onScrollUpEmitter: Emitter<void>
    onScrollYReachEnd: Event<void>
    onScrollYReachEndEmitter: Emitter<void>
    openerService: OpenerService
    pendingImageDisposables: Map<string, Disposable>

    Disposables for pending image registrations, keyed by short ID. These are cleared after the message is sent.

    pendingImageRegistry: PendingImageRegistry
    queryInFlight: boolean

    Suppresses capability updates while a query is in flight to prevent race conditions

    receivingAgent:
        | undefined
        | { agentId: string; currentModeId?: string; modes: ChatMode[] }
    resourceId: string = ...
    resources: InMemoryResources
    scrollBar?: PerfectScrollbar
    scrollOptions?: Options
    toDispose: DisposableCollection
    toDisposeOnDetach: DisposableCollection
    updateReceivingAgentTimeout: undefined | number
    userCapabilityOverrides: Map<string, boolean>

    Tracks user's explicit capability overrides for the current chat input session. Only contains capabilities the user has explicitly changed from their defaults. These overrides are not persisted but reset when the receiving agent changes or a new chat is started. Or restored when an existing chat session can provide a previous capability override from the last request.

    validationService: undefined | ContextFileValidationService
    variableService: FrontendVariableService
    CONTEXT_MENU: string[]
    ID: string = 'ask-ai-input-widget'

    Accessors

    • set chatModel(chatModel: ChatModel): void

      Parameters

      Returns void

    • get dataset(): DOMStringMap

      The dataset for the widget's DOM node.

      Returns DOMStringMap

    • get disposed(): ISignal<this, void>

      A signal emitted when the widget is disposed.

      Returns ISignal<this, void>

    • get editor(): undefined | SimpleMonacoEditor

      Returns undefined | SimpleMonacoEditor

    • get hiddenMode(): HiddenMode

      Get the method for hiding the widget.

      Returns HiddenMode

    • set hiddenMode(value: HiddenMode): void

      Set the method for hiding the widget.

      Parameters

      Returns void

    • get id(): string

      Get the id of the widget's DOM node.

      Returns string

    • set id(value: string): void

      Set the id of the widget's DOM node.

      Parameters

      • value: string

      Returns void

    • set initialValue(value: undefined | string): void

      Parameters

      • value: undefined | string

      Returns void

    • get isAttached(): boolean

      Test whether the widget's node is attached to the DOM.

      Returns boolean

    • get isDisposed(): boolean

      Test whether the widget has been disposed.

      Returns boolean

    • get isHidden(): boolean

      Test whether the widget is explicitly hidden.

      You should prefer !{@link isVisible} over {@link isHidden} if you want to know if the widget is hidden as this does not test if the widget is hidden because one of its ancestors is hidden.

      Returns boolean

    • get isVisible(): boolean

      Test whether the widget is visible.

      A widget is visible when it is attached to the DOM, is not explicitly hidden, and has no explicitly hidden ancestors.

      Since 2.7.0, this does not rely on the Widget.Flag.IsVisible flag. It recursively checks the visibility of all parent widgets.

      Returns boolean

    • get layout(): null | Layout

      Get the layout for the widget.

      Returns null | Layout

    • set layout(value: null | Layout): void

      Set the layout for the widget.

      The layout is single-use only. It cannot be changed after the first assignment.

      The layout is disposed automatically when the widget is disposed.

      Parameters

      Returns void

    • set onCancel(cancel: Cancel): void

      Parameters

      • cancel: Cancel

      Returns void

    • set onDeleteChangeSet(deleteChangeSet: DeleteChangeSet): void

      Parameters

      • deleteChangeSet: DeleteChangeSet

      Returns void

    • set onDeleteChangeSetElement(
          deleteChangeSetElement: DeleteChangeSetElement,
      ): void

      Parameters

      • deleteChangeSetElement: DeleteChangeSetElement

      Returns void

    • set onQuery(query: Query): void

      Parameters

      • query: Query

      Returns void

    • set onUnpin(unpin: Unpin): void

      Parameters

      • unpin: Unpin

      Returns void

    • get parent(): null | Widget

      Get the parent of the widget.

      Returns null | Widget

    • set parent(value: null | Widget): void

      Set the parent of the widget.

      Children are typically added to a widget by using a layout, which means user code will not normally set the parent widget directly.

      The widget will be automatically removed from its old parent.

      This is a no-op if there is no effective parent change.

      Parameters

      Returns void

    • set pinnedAgent(pinnedAgent: undefined | ChatAgent): void

      Parameters

      Returns void

    • get title(): Title<Widget>

      The title object for the widget.

      The title object is used by some container widgets when displaying the widget alongside some title, such as a tab panel or side bar.

      Since not all widgets will use the title, it is created on demand.

      The owner property of the title is set to this widget.

      Returns Title<Widget>

    Methods

    • Post an 'activate-request' message to the widget.

      This is a simple convenience method for posting the message.

      Returns void

    • Add a class name to the widget's DOM node.

      Parameters

      • name: string

        The class name to add to the node.

        If the class name is already added to the node, this is a no-op.

        The class name must not contain whitespace.

      Returns void

    • Type Parameters

      • K extends keyof HTMLElementEventMap

      Parameters

      • element: HTMLElement
      • type: K
      • OptionaluseCapture: boolean

      Returns void

    • Create an iterator over the widget's children.

      Returns IterableIterator<Widget>

      A new iterator over the children of the widget.

      The widget must have a populated layout in order to have children.

      If a layout is not installed, the returned iterator will be empty.

    • Clear the given widget flag.

      This will not typically be called directly by user code.

      Since 2.7.0, Widget.Flag.IsVisible is deprecated. It will be removed in a future version.

      Parameters

      Returns void

    • Clear all pending image attachments. Called after a message is sent.

      Returns void

    • Send a 'close-request' message to the widget.

      This is a simple convenience method for sending the message.

      Returns void

    • Test whether a widget is a descendant of this widget.

      Parameters

      • widget: Widget

        The descendant widget of interest.

      Returns boolean

      true if the widget is a descendant, false otherwise.

    • Returns void

    • Delete a context element by index.

      Parameters

      • index: number

      Returns void

    • Parameters

      • scrollContainer: HTMLElement

      Returns void

    • Dispose of the widget and its descendant widgets.

      It is unsafe to use the widget after it has been disposed.

      All calls made to this method after the first are a no-op.

      Returns void

    • Post a 'fit-request' message to the widget.

      This is a simple convenience method for posting the message.

      Returns void

    • Focus the chat session by setting it as active with focus.

      Parameters

      • sessionId: string

      Returns void

    • Get a meaningful base name for an image variable. For dropped files (with wsRelativePath), use the workspace-relative path (like file variables). For pasted images, use "pasted_image".

      Parameters

      Returns string

    • Parameters

      • commandId: string

      Returns undefined | string

    • Extracts capability overrides from the last request in the chat model. Used to restore user's capability choices when switching sessions or on reload.

      Parameters

      Returns Map<string, boolean>

    • Returns undefined | string

    • Returns undefined | Node

    • Parameters

      • currentInput: string

      Returns undefined | string

    • Get the scope URI used for registering pending images. Uses the chat model ID for scoping, not the editor URI.

      Returns string

    • Parameters

      • event: IMouseEvent

      Returns void

    • Parameters

      • isNowVisible: boolean

      Returns void

    • Test whether the widget's DOM node has the given class name.

      Parameters

      • name: string

        The class name of interest.

      Returns boolean

      true if the node has the class, false otherwise.

    • Hide the widget and make it hidden to its parent widget.

      This causes the isHidden property to be true.

      If the widget is explicitly hidden, this is a no-op.

      Returns void

    • Check if the specific chat session is currently focused. Returns true only if the chat widget is focused AND viewing the same session.

      Parameters

      • sessionId: string

      Returns boolean

    • Invoke the message processing routine of the widget's layout.

      Parameters

      • msg: Message

        The message to dispatch to the layout.

        This is a no-op if the widget does not have a layout.

        This will not typically be called directly by user code.

      Returns void

    • A message handler invoked on an 'activate-request' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • A message handler invoked on an 'after-attach' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • A message handler invoked on an 'after-detach' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • A message handler invoked on an 'after-hide' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • A message handler invoked on an 'after-show' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • A message handler invoked on a 'before-attach' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • A message handler invoked on a 'before-detach' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • A message handler invoked on a 'before-hide' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • A message handler invoked on a 'before-show' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • A message handler invoked on a 'child-added' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • A message handler invoked on a 'child-removed' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • A message handler invoked on a 'close-request' message.

      The default implementation unparents or detaches the widget.

      Parameters

      Returns void

    • Parameters

      • event: DragEvent

      Returns void

    • Parameters

      • event: DragEvent

      Returns void

    • A message handler invoked on a 'fit-request' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • Parameters

      • event: ClipboardEvent

      Returns void

    • A message handler invoked on an 'update-request' message.

      The default implementation of this handler is a no-op.

      Parameters

      Returns void

    • Process a message sent to the widget.

      Parameters

      • msg: Message

        The message sent to the widget.

        Subclasses may reimplement this method as needed.

      Returns void

    • Refreshes capabilities for the current receiving agent. Called when prompt fragments change to ensure capabilities reflect the latest template.

      Returns Promise<void>

    • Remove a class name from the widget's DOM node.

      Parameters

      • name: string

        The class name to remove from the node.

        If the class name is not yet added to the node, this is a no-op.

        The class name must not contain whitespace.

      Returns void

    • Render the React widget in the DOM.

      • If the widget has been previously rendered, any subsequent calls will perform an update and only change the DOM if absolutely necessary.

      Returns ReactNode

    • Parameters

      • enabled: boolean

      Returns void

    • Set the given widget flag.

      This will not typically be called directly by user code.

      Since 2.7.0, Widget.Flag.IsVisible is deprecated. It will be removed in a future version.

      Parameters

      Returns void

    • Show or hide the widget according to a boolean value.

      Parameters

      • hidden: boolean

        true to hide the widget, or false to show it.

        This is a convenience method for hide() and show().

      Returns void

    • Show the widget and make it visible to its parent widget.

      This causes the isHidden property to be false.

      If the widget is not explicitly hidden, this is a no-op.

      Returns void

    • Test whether the given widget flag is set.

      This will not typically be called directly by user code.

      Since 2.7.0, Widget.Flag.IsVisible is deprecated. It will be removed in a future version.

      Parameters

      Returns boolean

    • Toggle a class name on the widget's DOM node.

      Parameters

      • name: string

        The class name to toggle on the node.

      • Optionalforce: boolean

        Whether to force add the class (true) or force remove the class (false). If not provided, the presence of the class will be toggled from its current state.

      Returns boolean

      true if the class is now present, false otherwise.

      The class name must not contain whitespace.

    • Post an 'update-request' message to the widget.

      This is a simple convenience method for posting the message.

      Returns void

    • Updates the receiving agent state and triggers re-render if the agent changed.

      Parameters

      Returns Promise<void>

    • Parameters

      • agentId: string
      • OptionalmodeId: string
      • OptionalpreserveOverrides: boolean

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    _branch_chatModel_initialValue_onCancel_onDeleteChangeSet_onDeleteChangeSetElement_onQuery_onUnpin_pinnedAgentagentNotificationServiceaiActivationServiceapplicationShellargsavailableGenericCapabilitiescapabilitiesOpencapabilitiesServicecapabilityDefaultschangeSetActionServicechangeSetDecoratorServicechatAgentServicechatInputFirstLineKeychatInputFocusKeychatInputFocusServicechatInputHasModesKeychatInputLastLineKeychatInputReceivingAgentKeychatRequestParserchatServiceconfigurationcontextKeyServicecontextMenuRenderercontextVariablePickerdisabledGenericCapabilitieseditorProvidereditorReadyeditorReffileValidationStateforceCapabilitiesRefreshgenericCapabilitiesServicegenericCapabilitySelectionshandleCapabilityChangehandleGenericCapabilityChangehandleModeChangeheightInLineshistoryServicehoverServiceisEnabledkeybindingRegistrylabelProvidernavigationStatenodenodeRootonDidChangeVisibilityonDidChangeVisibilityEmitteronDidDisposeonDidDisposeEmitteronDidResizeonDidResizeEmitteronDisposeForChatModelonScrollUponScrollUpEmitteronScrollYReachEndonScrollYReachEndEmitteropenerServicependingImageDisposablespendingImageRegistryqueryInFlightreceivingAgentresourceIdresourcesscrollBarscrollOptionstoDisposetoDisposeOnDetachupdateReceivingAgentTimeoutuserCapabilityOverridesvalidationServicevariableServiceCONTEXT_MENUID
    Accessors
    Methods
    activateaddClassaddClipboardListeneraddContextaddContextElementaddEventListeneraddKeyListeneraddUpdateListenerchildrenclearFlagclearPendingImageAttachmentsclosecontainscycleModedeleteContextElementdisableScrollBarFocusdisposefitfocusChatSessiongetAllVariablesForRequestgetCapabilitiesKeybindingHintgetContextgetImageBaseNamegetKeybindingHintgetLastCapabilityOverridesFromModelgetLastGenericCapabilitySelectionsFromModelgetModeKeybindingHintgetNextPromptgetPreviewNodegetPreviousPromptgetResourceUrigetScopeUrigetScrollContainerhandleAgentCompletionhandleCancelhandleContextMenuhandleSubmithandleVisiblityChangedhasClasshideinitinitializeContextKeysisChatSessionFocusednotifyLayoutonActivateRequestonAfterAttachonAfterDetachonAfterHideonAfterShowonBeforeAttachonBeforeDetachonBeforeHideonBeforeShowonChildAddedonChildRemovedonCloseRequestonDragOveronDroponEscapeonFitRequestonPasteonResizeonUpdateRequestopenContextElementprocessMessagerefreshCapabilitiesregisterPendingImageremoveClassrenderresolveAgentFromParsedRequestscheduleUpdateReceivingAgentsetEnabledsetFlagsetHiddensetupEditorEventListenersshowtestFlagtoggleCapabilitiestoggleClassupdateupdateAgentStateupdateAvailableGenericCapabilitiesupdateCapabilitiesForAgentupdateCursorPositionKeysupdateReceivingAgent