Having a Widget open by default

Sreeranjani · 7 April 2022 10:00

I am creating a new widget, I wanted it to be opened by default when the IDE is launched, I tried using

async initializeLayout(app: FrontendApplication): Promise {
await this.openView({activate: false, reveal: true});
}

but this is not working

vince-fugnitto · 7 April 2022 11:54

@Sreeranjani thank you for the discussion

If we look at the documentation for initializeLayout we’ll see that the method is used to define a default layout for the application, since it applies when no workbench state exists:

github.com

eclipse-theia/theia/blob/1c7bdf70025c684e7ca22c482e206cceb405ddbd/packages/core/src/browser/frontend-application.ts#L68-L72


/**
 * Called after the application shell has been attached in case there is no previous workbench layout state.
 * Should return a promise if it runs asynchronously.
 */
initializeLayout?(app: FrontendApplication): MaybePromise<void>;

Instead, you’ll probably always want to display the widget or under certain conditions so you can follow the way that the getting-started view works:

github.com

eclipse-theia/theia/blob/1c7bdf70025c684e7ca22c482e206cceb405ddbd/packages/getting-started/src/browser/getting-started-contribution.ts#L51-L57


async onStart(app: FrontendApplication): Promise<void> {
    if (!this.workspaceService.opened) {
        this.stateService.reachedState('ready').then(
            () => this.openView({ reveal: true })
        );
    }
}

It uses the application’s onStart lifecycle hook to open your view.

Sreeranjani · 7 April 2022 12:12

Thanks for the suggestions, I will look into it

Sreeranjani · 7 April 2022 12:49

I was able to get this working. Thanks