@ckeditor/ckeditor5-ai/src/aitabs/aitabsmainview.d.ts

AI features for CKEditor 5.

/**
 * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
 * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
 */
/**
 * @module ai/aitabs/aitabsmainview
 * @publicApi
 */
import type { Locale } from 'ckeditor5/src/utils.js';
import { AITabsView, type AITabsViewOptions } from './tabs/aitabsview.js';
import '../../theme/aitabs/aitabsview.css';
/**
 * The supported types of the `AITabsView`.
 */
export declare const AI_TABS_VIEW_TYPES: readonly ["overlay", "sidebar", "custom"];
/**
 * The supported sides of the `AITabsView`.
 */
export declare const AI_TABS_VIEW_SIDES: readonly ["left", "right"];
/**
 * The view that hosts AI-powered features in the editor.
 */
export declare class AITabsMainView extends AITabsView {
    /**
     * The type of the view.
     */
    type: AITabsMainViewOptions['type'];
    /**
     * Whether the AI tabs view is visible.
     *
     * @observable
     */
    isVisible: boolean;
    /**
     * @inheritDoc
     */
    constructor(locale: Locale, options?: AITabsMainViewOptions);
}
/**
 * The options for the `AITabsView` class constructor.
 */
export type AITabsMainViewOptions = AITabsViewOptions & {
    /**
     * The type of the AI Tabs view. The possible values are:
     *
     * * `'overlay'` - the tabs are displayed as an overlay on top of the web page,
     * * `'sidebar'` - the tabs are displayed in a user-defined container,
     * * `'custom'` - the tabs are displayed as a custom UI, the integrator is responsible for the layout.
     */
    type?: (typeof AI_TABS_VIEW_TYPES)[number];
    /**
     * Whether the AI interface should be visible when created.
     */
    visibleByDefault?: boolean;
};