Interface ApplicationShellLayoutMigration

Hierarchy

ApplicationShellLayoutMigration

Index

Properties

layoutVersion

Methods

Properties

Readonly layoutVersion

layoutVersion: ApplicationShellLayoutVersion

A target migration version.

Methods

Optional onWillInflateLayout

onWillInflateLayout(context: ApplicationShellLayoutMigrationContext): MaybePromise<void>

- Defined in packages/core/src/browser/shell/shell-layout-restorer.ts:102
A migration can transform layout before it will be inflated.

throws
ApplicationShellLayoutMigrationError if a layout cannot be migrated, in this case the default layout will be initialized.

Parameters
- context: ApplicationShellLayoutMigrationContext
Returns MaybePromise<void>

Optional onWillInflateWidget

onWillInflateWidget(desc: WidgetDescription, context: ApplicationShellLayoutMigrationContext): MaybePromise<undefined | WidgetDescription>

- Defined in packages/core/src/browser/shell/shell-layout-restorer.ts:111
A migration can transform the given description before it will be inflated.

throws
ApplicationShellLayoutMigrationError if a widget description cannot be migrated, in this case the default layout will be initialized.

Parameters
- desc: WidgetDescription
- context: ApplicationShellLayoutMigrationContext
Returns MaybePromise<undefined | WidgetDescription>
a migrated widget description, or undefined