Sign up (with export icon)

AIContainerCustom

Api-interface iconinterface

The configuration of the AI user interface container in the custom mode.

In this mode, integrator is responsible for rendering the AI user interface in the web page.

  • Use view to access the view of the AI user interface,
  • Use getTabIds to read available IDs of individual tabs in the AI user interface,
  • Use getTab to access individual tab views in the AI user interface,
  • Use addTab to add a new tab to the AI user interface,
  • Use activateTab to switch between tabs from the code.

For example, to integrate the AI user interface with custom containers on the web page, use the following code:

	const tabsPlugin = editor.plugins.get( 'AITabs' );

	for ( const id of tabsPlugin.view.getTabIds() ) {
		const tab = tabsPlugin.view.getTab( id );

		// Display tab button and panel in a custom container.
		myButtonsContainer.appendChild( tab.button.element );
		myPanelContainer.appendChild( tab.panel.element );
	}
Copy code

Properties

  • Chevron-right icon

    showResizeButton : boolean | undefined
    inherited

    This option is used to show or hide the resize button in the AI user interface.

    Defaults to true.

  • type : 'custom'

  • Chevron-right icon

    visibleByDefault : boolean | undefined
    inherited

    Whether the AI interface should be visible when the editor is created.