# FullscreenConfig

interface

The configuration of the fullscreen mode feature.

The properties defined in this config are set in the `config.fullscreen` namespace.

```typescript
ClassicEditor
	.create( {
		fullscreen: {
			// Fullscreen mode configuration.
		}
	} )
	.then( ... )
	.catch( ... );
```

See [all editor options](module_core_editor_editorconfig-EditorConfig.md).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-fullscreen/src/fullscreenconfig.ts#L28)

<a id="properties">

## Properties

<a id="member-container">

### `container?: ShadowRoot | HTMLElement`

The container element for the fullscreen mode. This should be a reference to an existing, positioned element in the DOM.

By default, the fullscreen mode is appended to the shared [`ui.overlayContainer`](module_core_editor_editorconfig-UiConfig.md#member-overlayContainer) if it is set, otherwise to the shadow root the editor lives in (open or closed), otherwise to the `<body>` element. Mounting it in the root the editor lives in is what keeps the editor UI moved to the fullscreen mode (editable, toolbar, menu bar, sidebars) styled – in a shadow root, the editor stylesheets are adopted by that root only.

Setting it to anything else than that default also keeps the page scrollable, as the fullscreen mode then fills an element of the page layout instead of covering the viewport.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-fullscreen/src/fullscreenconfig.ts#L58)

<a id="member-menuBar">

### `menuBar?: object`

The configuration of the menu bar in the fullscreen mode.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-fullscreen/src/fullscreenconfig.ts#L63)

<a id="member-onEnterCallback">

### `onEnterCallback?: ( container: HTMLElement ) => void`

Customizable callback that is called when you enter the fullscreen mode. It's executed after the editor UI elements are moved to the fullscreen mode.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-fullscreen/src/fullscreenconfig.ts#L36)

Defaults to `` `() => {}` ``

<a id="member-onLeaveCallback">

### `onLeaveCallback?: ( container: HTMLElement ) => void`

Customizable callback that is called when you leave the fullscreen mode. It's executed before the editor UI elements are moved back to the normal mode.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-fullscreen/src/fullscreenconfig.ts#L44)

Defaults to `` `() => {}` ``

<a id="member-toolbar">

### `toolbar?: object`

The configuration of the toolbar in the fullscreen mode.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-fullscreen/src/fullscreenconfig.ts#L76)

---

Full index of the CKEditor 5 API reference: [llms.txt](llms.txt)