Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature Request: Configurable Splash Screen for Theia Electron #13410

Closed
sdirix opened this issue Feb 22, 2024 · 2 comments
Closed

Feature Request: Configurable Splash Screen for Theia Electron #13410

sdirix opened this issue Feb 22, 2024 · 2 comments
Labels
electron issues related to the electron target

Comments

@sdirix
Copy link
Member

sdirix commented Feb 22, 2024

Splash screens are an often implemented feature as they can improve user experience while also offering a branding opportunity.

In case a splash screen is implemented for a Theia based application, it naturally makes sense to show it until the frontend is fully loaded, i.e. until the loading spinner vanishes. For this, framework support is useful.

Suggested requirements:

  • The splash screen support is off by default and must be explicitly configured
  • Typical splash screen use cases should be configurable via the package.json
  • The splash screen should allow content customization similar to the preloadContent
  • The splash screen should be displayed as early as possible during startup, with the frontend application loading invisible in the background.
  • The splash screen should be hidden once the frontend app is fully loaded, revealing the frontend at the same time

The splash screen configuration could also support the following parameters:

  • minDuration: number: Minimum duration to show the splash screen, in milliseconds. Defaults to undefined, indicating this feature is disabled.
  • maxDuration: number: Maximum duration to show the splash screen, in milliseconds. Defaults to undefined, indicating this feature is disabled.
  • width: number: Width of the splash screen in pixels. Default value 640.
  • height: number: Height of the splash screen in pixels. Default value 480.
@msujew
Copy link
Member

msujew commented Feb 22, 2024

@kittaakos Is this still interesting for you guys over at Arduino?

@msujew msujew added the electron issues related to the electron target label Feb 22, 2024
sdirix added a commit to eclipsesource/theia that referenced this issue Mar 19, 2024
Enhances the ElectronMainApplication to optionally render a splash
screen until the frontend is ready.

The splash screen can be configured via the application config object
"theia.frontend.config.electron.splashScreenOptions". Mandatory is the
option "content" which specifies a relative path from the frontend
location to the content of the splash screen. Optionally "width",
"height", "minDuration" and "maxDuration" can be handed over too.

Implements eclipse-theia#13410
sdirix added a commit to eclipsesource/theia that referenced this issue Mar 19, 2024
Enhances the ElectronMainApplication to optionally render a splash
screen until the frontend is ready.

The splash screen can be configured via the application config object
"theia.frontend.config.electron.splashScreenOptions". Mandatory is the
option "content" which specifies a relative path from the frontend
location to the content of the splash screen. Optionally "width",
"height", "minDuration" and "maxDuration" can be handed over too.

Implements eclipse-theia#13410
sdirix added a commit to eclipsesource/theia that referenced this issue Mar 25, 2024
Enhances the ElectronMainApplication to optionally render a splash
screen until the frontend is ready.

The splash screen can be configured via the application config object
"theia.frontend.config.electron.showWindowEarly". Mandatory is the
option "content" which specifies a relative path from the frontend
location to the content of the splash screen. Optionally "width",
"height", "minDuration" and "maxDuration" can be handed over too.

Implements eclipse-theia#13410

Contributed on behalf of Pragmatiqu IT GmbH
sdirix added a commit to eclipsesource/theia that referenced this issue Mar 25, 2024
Enhances the ElectronMainApplication to optionally render a splash
screen until the frontend is ready.

The splash screen can be configured via the application config object
"theia.frontend.config.electron.showWindowEarly". Mandatory is the
option "content" which specifies a relative path from the frontend
location to the content of the splash screen. Optionally "width",
"height", "minDuration" and "maxDuration" can be handed over too.

Implements eclipse-theia#13410

Contributed on behalf of Pragmatiqu IT GmbH
sdirix added a commit to eclipsesource/theia that referenced this issue Mar 25, 2024
Enhances the ElectronMainApplication to optionally render a splash
screen until the frontend is ready.

The splash screen can be configured via the application config object
"theia.frontend.config.electron.showWindowEarly". Mandatory is the
option "content" which specifies a relative path from the frontend
location to the content of the splash screen. Optionally "width",
"height", "minDuration" and "maxDuration" can be handed over too.

Configures the Electron example application to show a Theia logo splash
screen.

Implements eclipse-theia#13410

Contributed on behalf of Pragmatiqu IT GmbH
sdirix added a commit to eclipsesource/theia that referenced this issue Mar 26, 2024
Enhances the ElectronMainApplication to optionally render a splash
screen until the frontend is ready.

The splash screen can be configured via the application config object
"theia.frontend.config.electron.showWindowEarly". Mandatory is the
option "content" which specifies a relative path from the frontend
location to the content of the splash screen. Optionally "width",
"height", "minDuration" and "maxDuration" can be handed over too.

Configures the Electron example application to show a Theia logo splash
screen.

Implements eclipse-theia#13410

Contributed on behalf of Pragmatiqu IT GmbH
sdirix added a commit to eclipsesource/theia that referenced this issue Mar 27, 2024
Enhances the ElectronMainApplication to optionally render a splash
screen until the frontend is ready.

The splash screen can be configured via the application config object
"theia.frontend.config.electron.splashScreenOptions". Mandatory is the
option "content" which specifies a relative path from the application
root to the content of the splash screen. Optionally "width", "height",
"minDuration" and "maxDuration" can be handed over too.

Configures the Electron example application to show a Theia logo splash
screen.

Implements eclipse-theia#13410

Contributed on behalf of Pragmatiqu IT GmbH
sdirix added a commit to eclipsesource/theia that referenced this issue Mar 27, 2024
Enhances the ElectronMainApplication to optionally render a splash
screen until the frontend is ready.

The splash screen can be configured via the application config object
"theia.frontend.config.electron.splashScreenOptions". Mandatory is the
option "content" which specifies a relative path from the application
root to the content of the splash screen. Optionally "width", "height",
"minDuration" and "maxDuration" can be handed over too.

Configures the Electron example application to show a Theia logo splash
screen.

Implements eclipse-theia#13410

Contributed on behalf of Pragmatiqu IT GmbH
sdirix added a commit to eclipsesource/theia that referenced this issue Mar 27, 2024
Enhances the ElectronMainApplication to optionally render a splash
screen until the frontend is ready.

The splash screen can be configured via the application config object
"theia.frontend.config.electron.splashScreenOptions". Mandatory is the
option "content" which specifies a relative path from the application
root to the content of the splash screen. Optionally "width", "height",
"minDuration" and "maxDuration" can be handed over too.

Configures the Electron example application to show a Theia logo splash
screen.

Implements eclipse-theia#13410

Contributed on behalf of Pragmatiqu IT GmbH
sdirix added a commit to eclipsesource/theia that referenced this issue Mar 27, 2024
Enhances the ElectronMainApplication to optionally render a splash
screen until the frontend is ready.

The splash screen can be configured via the application config object
"theia.frontend.config.electron.splashScreenOptions". Mandatory is the
option "content" which specifies a relative path from the application
root to the content of the splash screen. Optionally "width", "height",
"minDuration" and "maxDuration" can be handed over too.

Configures the Electron example application to show a Theia logo splash
screen.

Implements eclipse-theia#13410

Contributed on behalf of Pragmatiqu IT GmbH
sdirix added a commit to eclipsesource/theia that referenced this issue Mar 27, 2024
Enhances the ElectronMainApplication to optionally render a splash
screen until the frontend is ready.

The splash screen can be configured via the application config object
"theia.frontend.config.electron.splashScreenOptions". Mandatory is the
option "content" which specifies a relative path from the application
root to the content of the splash screen. Optionally "width", "height",
"minDuration" and "maxDuration" can be handed over too.

Configures the Electron example application to show a Theia logo splash
screen.

Implements eclipse-theia#13410

Contributed on behalf of Pragmatiqu IT GmbH
tsmaeder pushed a commit that referenced this issue Apr 29, 2024
Enhances the ElectronMainApplication to optionally render a splash
screen until the frontend is ready.

The splash screen can be configured via the application config object
"theia.frontend.config.electron.splashScreenOptions". Mandatory is the
option "content" which specifies a relative path from the application
root to the content of the splash screen. Optionally "width", "height",
"minDuration" and "maxDuration" can be handed over too.

Configures the Electron example application to show a Theia logo splash
screen.

Implements #13410

Contributed on behalf of Pragmatiqu IT GmbH
@tsmaeder
Copy link
Contributor

tsmaeder commented Aug 6, 2024

We now have a splash screen.

@tsmaeder tsmaeder closed this as completed Aug 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
electron issues related to the electron target
Projects
None yet
Development

No branches or pull requests

3 participants