Sign up (with export icon)

AIContainerOverlay

Api-interface iconinterface

The configuration of the AI user interface container in the overlay mode. In this mode, the AI user interface is displayed on top of the web page on a preferred side. This mode is best suited for integrations with limited space.

ClassicEditor
	.create( {
		attachTo: document.querySelector( '#editor' ),
		// ... Other configuration options ...
		ai: {
			container: {
				type: 'overlay',
				side: 'right'
			},
		}
	} )
	.then( ... )
	.catch( ... );
Copy code

Properties

  • Chevron-right icon

    collapsible : boolean | undefined
    inherited

    When true, clicking the active tab button collapses the panel and toggles the ck-ai-tabs_collapsed CSS class on the AI tabs DOM element. Clicking the tab again expands it back. When false, clicking the active tab button is a no-op.

    Defaults to false.

  • 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.

  • side : AIContainerSide | undefined

  • type : 'overlay'

  • Chevron-right icon

    visibleByDefault : boolean | undefined
    inherited

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