GoodData.UI API reference
  • All Products
  • All Products
  • GoodData.UI
  • API Reference
  • University
  • Community
  • Documentation
  • Support
  • 11.45.0
  • Code samples
  • GitHub

onChatToggleRequested

Home > @gooddata/sdk-pluggable-application-model > IHostUiMountOptions > onChatToggleRequested

IHostUiMountOptions.onChatToggleRequested property

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Requests the host to toggle its AI assistant chat open/closed.

Signature:

onChatToggleRequested?: () => void;

Remarks

The single chat instance is owned by the host runtime (outside the host UI module), so it survives a custom UI module and stays mounted when the chrome is hidden (embedded/export). The host UI's header chat button calls this to toggle that chat. The current open-state and button visibility are pushed back via IHostUiMountHandle.updateChatState().

  • IHostUiMountOptions.onChatToggleRequested property
  • Remarks
GoodData resources:
  • Documentation
Follow the community:
  • Community
Copyright © 2007–2026 GoodData Corporation. All Rights Reserved. Code licensed under a dual license - CC BY‑NC 4.0 for trial experience and GoodData.UI EULA for commercial use