Interface ApplicationShellLayoutMigration

interface ApplicationShellLayoutMigration {
    layoutVersion: ApplicationShellLayoutVersion;
    onWillInflateLayout?(
        context: ApplicationShellLayoutMigrationContext,
    ): MaybePromise<void>;
    onWillInflateWidget?(
        desc: WidgetDescription,
        context: ApplicationShellLayoutMigrationContext,
    ): MaybePromise<undefined | WidgetDescription>;
}

Implemented by

Index

Properties

Methods

onWillInflateLayout? onWillInflateWidget?

Properties

`Readonly`layoutVersion

layoutVersion: ApplicationShellLayoutVersion

A target migration version.

Methods

`Optional`onWillInflateLayout

onWillInflateLayout?(
context: ApplicationShellLayoutMigrationContext,
): MaybePromise<void>
A migration can transform layout before it will be inflated.
Parameters
- context: ApplicationShellLayoutMigrationContext
Returns MaybePromise<void>
Throws
ApplicationShellLayoutMigrationError if a layout cannot be migrated, in this case the default layout will be initialized.
- Defined in packages/core/src/browser/shell/shell-layout-restorer.ts:102

`Optional`onWillInflateWidget

onWillInflateWidget?(
desc: WidgetDescription,
context: ApplicationShellLayoutMigrationContext,
): MaybePromise<undefined | WidgetDescription>
A migration can transform the given description before it will be inflated.
Parameters
- desc: WidgetDescription
- context: ApplicationShellLayoutMigrationContext
Returns MaybePromise<undefined | WidgetDescription>
a migrated widget description, or undefined

Throws
ApplicationShellLayoutMigrationError if a widget description cannot be migrated, in this case the default layout will be initialized.
- Defined in packages/core/src/browser/shell/shell-layout-restorer.ts:111