customPanels.getPanel() - IBM watsonx Orchestrate ADK

Returns the single custom panel instance for the chat. Use the returned object to open, close, and populate the custom panel. Only one custom panel exists per chat instance at any time. If you want to display different content, replace the content of customPanel.hostElement rather than opening multiple panels.

Syntax

const customPanel = instance.customPanels.getPanel();

Parameters

None.

Returns

object

The custom panel instance. Use the returned object to call customPanel.open(), customPanel.close(), and access customPanel.hostElement.

Example

const customPanel = instance.customPanels.getPanel();

// Populate the panel with custom content
customPanel.hostElement.innerHTML = `
  <div style="padding: 16px;">
    <h2>Custom Content</h2>
    <p>Your custom HTML goes here.</p>
  </div>
`;

// Open the panel
await customPanel.open({ title: 'My Panel' });

Do you need practical examples?

Learn how to apply the features available for embedded chat into your implementation with guidance and examples.